io.swagger.models.parameters

Class AbstractSerializableParameter<T extends AbstractSerializableParameter<T>>

java.lang.Object

io.swagger.models.parameters.AbstractParameter

io.swagger.models.parameters.AbstractSerializableParameter<T>

All Implemented Interfaces:

Parameter, SerializableParameter

Direct Known Subclasses:

CookieParameter, FormParameter, HeaderParameter, PathParameter, QueryParameter

public abstract class AbstractSerializableParameter<T extends AbstractSerializableParameter<T>>
extends AbstractParameter
implements SerializableParameter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	_enum
protected java.lang.Boolean	allowEmptyValue
protected java.lang.String	collectionFormat
protected java.lang.String	defaultValue
protected java.lang.String	example
protected java.lang.Boolean	exclusiveMaximum
protected java.lang.Boolean	exclusiveMinimum
protected java.lang.String	format
protected Property	items
protected java.math.BigDecimal	maximum
java.lang.Integer	maxLength See http://json-schema.org/latest/json-schema-validation.html#anchor26
protected java.math.BigDecimal	minimum
java.lang.Integer	minLength See http://json-schema.org/latest/json-schema-validation.html#anchor29
java.lang.Number	multipleOf See http://json-schema.org/latest/json-schema-validation.html#anchor14
java.lang.String	pattern See http://json-schema.org/latest/json-schema-validation.html#anchor33
protected java.lang.String	type
java.lang.Boolean	uniqueItems See http://json-schema.org/latest/json-schema-validation.html#anchor49

Fields inherited from class io.swagger.models.parameters.AbstractParameter

access, description, in, name, readOnly, required

Constructor Summary

Constructors

Constructor and Description
AbstractSerializableParameter()

Method Summary

Modifier and Type	Method and Description
T	_enum(java.util.List<java.lang.String> value)
T	allowEmptyValue(java.lang.Boolean allowEmpty)
T	collectionFormat(java.lang.String collectionFormat)
T	description(java.lang.String description)
boolean	equals(java.lang.Object obj)
T	example(java.lang.String example)
T	format(java.lang.String format)
java.lang.Boolean	getAllowEmptyValue()
java.lang.String	getCollectionFormat()
java.lang.Object	getDefault()
protected java.lang.String	getDefaultCollectionFormat()
java.lang.Object	getDefaultValue()
java.util.List<java.lang.String>	getEnum()
java.util.List<java.lang.Object>	getEnumValue()
java.lang.Object	getExample()
java.lang.String	getFormat()
Property	getItems()
java.math.BigDecimal	getMaximum()
java.lang.Integer	getMaxItems()
java.lang.Integer	getMaxLength()
java.math.BigDecimal	getMinimum()
java.lang.Integer	getMinItems()
java.lang.Integer	getMinLength()
java.lang.Number	getMultipleOf()
java.lang.String	getPattern()
java.lang.String	getType()
int	hashCode()
java.lang.Boolean	isExclusiveMaximum()
java.lang.Boolean	isExclusiveMinimum()
java.lang.Boolean	isUniqueItems()
T	items(Property items)
T	name(java.lang.String name)
T	property(Property property)
T	readOnly(java.lang.Boolean readOnly)
T	required(boolean required)
void	setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
void	setCollectionFormat(java.lang.String collectionFormat)
void	setDefault(java.lang.Object defaultValue)
void	setDefaultValue(java.lang.String defaultValue)
void	setEnum(java.util.List<java.lang.String> _enum)
void	setEnumValue(java.util.List<?> enumValue)
void	setExample(java.lang.String example)
void	setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)
void	setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)
void	setFormat(java.lang.String format)
void	setItems(Property items)
void	setMaximum(java.math.BigDecimal maximum)
void	setMaxItems(java.lang.Integer maxItems)
void	setMaxLength(java.lang.Integer maxLength)
void	setMinimum(java.math.BigDecimal minimum)
void	setMinItems(java.lang.Integer minItems)
void	setMinLength(java.lang.Integer minLength)
void	setMultipleOf(java.lang.Number multipleOf)
void	setPattern(java.lang.String pattern)
void	setProperty(Property property)
void	setType(java.lang.String type)
void	setUniqueItems(java.lang.Boolean uniqueItems)
T	type(java.lang.String type)

Methods inherited from class io.swagger.models.parameters.AbstractParameter

getAccess, getDescription, getIn, getName, getRequired, getVendorExtensions, isReadOnly, setAccess, setDescription, setIn, setName, setReadOnly, setRequired, setVendorExtension, setVendorExtensions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.swagger.models.parameters.Parameter

getAccess, getDescription, getIn, getName, getRequired, getVendorExtensions, isReadOnly, setAccess, setDescription, setIn, setName, setReadOnly, setRequired

Field Detail

type

protected java.lang.String type

format

protected java.lang.String format

collectionFormat

protected java.lang.String collectionFormat

items

protected Property items

exclusiveMaximum

protected java.lang.Boolean exclusiveMaximum

maximum

protected java.math.BigDecimal maximum

exclusiveMinimum

protected java.lang.Boolean exclusiveMinimum

minimum

protected java.math.BigDecimal minimum

example

protected java.lang.String example

allowEmptyValue

protected java.lang.Boolean allowEmptyValue

_enum

protected java.util.List<java.lang.String> _enum

maxLength

public java.lang.Integer maxLength

See http://json-schema.org/latest/json-schema-validation.html#anchor26

minLength

public java.lang.Integer minLength

See http://json-schema.org/latest/json-schema-validation.html#anchor29

pattern

public java.lang.String pattern

See http://json-schema.org/latest/json-schema-validation.html#anchor33

uniqueItems

public java.lang.Boolean uniqueItems

See http://json-schema.org/latest/json-schema-validation.html#anchor49

multipleOf

public java.lang.Number multipleOf

See http://json-schema.org/latest/json-schema-validation.html#anchor14

defaultValue

protected java.lang.String defaultValue

Constructor Detail

AbstractSerializableParameter

public AbstractSerializableParameter()

Method Detail

property

public T property(Property property)

type

public T type(java.lang.String type)

format

public T format(java.lang.String format)

description

public T description(java.lang.String description)

name

public T name(java.lang.String name)

required

public T required(boolean required)

collectionFormat

public T collectionFormat(java.lang.String collectionFormat)

example

public T example(java.lang.String example)

allowEmptyValue

public T allowEmptyValue(java.lang.Boolean allowEmpty)

readOnly

public T readOnly(java.lang.Boolean readOnly)

getDefaultCollectionFormat

protected java.lang.String getDefaultCollectionFormat()

items

public T items(Property items)

_enum

public T _enum(java.util.List<java.lang.String> value)

getEnum

public java.util.List<java.lang.String> getEnum()

Specified by:

getEnum in interface SerializableParameter

setEnum

public void setEnum(java.util.List<java.lang.String> _enum)

Specified by:

setEnum in interface SerializableParameter

getEnumValue

public java.util.List<java.lang.Object> getEnumValue()

Specified by:

getEnumValue in interface SerializableParameter

setEnumValue

public void setEnumValue(java.util.List<?> enumValue)

Specified by:

setEnumValue in interface SerializableParameter

getItems

public Property getItems()

Specified by:

getItems in interface SerializableParameter

setItems

public void setItems(Property items)

Specified by:

setItems in interface SerializableParameter

getFormat

public java.lang.String getFormat()

Specified by:

getFormat in interface SerializableParameter

setFormat

public void setFormat(java.lang.String format)

Specified by:

setFormat in interface SerializableParameter

getType

public java.lang.String getType()

Specified by:

getType in interface SerializableParameter

setType

public void setType(java.lang.String type)

Specified by:

setType in interface SerializableParameter

getCollectionFormat

public java.lang.String getCollectionFormat()

Specified by:

getCollectionFormat in interface SerializableParameter

setCollectionFormat

public void setCollectionFormat(java.lang.String collectionFormat)

Specified by:

setCollectionFormat in interface SerializableParameter

setProperty

public void setProperty(Property property)

getDefaultValue

public java.lang.Object getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

getDefault

public java.lang.Object getDefault()

setDefault

public void setDefault(java.lang.Object defaultValue)

setExclusiveMaximum

public void setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)

Specified by:

setExclusiveMaximum in interface SerializableParameter

getMaximum

public java.math.BigDecimal getMaximum()

Specified by:

getMaximum in interface SerializableParameter

setMaximum

public void setMaximum(java.math.BigDecimal maximum)

Specified by:

setMaximum in interface SerializableParameter

isExclusiveMinimum

public java.lang.Boolean isExclusiveMinimum()

Specified by:

isExclusiveMinimum in interface SerializableParameter

setExclusiveMinimum

public void setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)

Specified by:

setExclusiveMinimum in interface SerializableParameter

getMinimum

public java.math.BigDecimal getMinimum()

Specified by:

getMinimum in interface SerializableParameter

setMinimum

public void setMinimum(java.math.BigDecimal minimum)

Specified by:

setMinimum in interface SerializableParameter

getMaxItems

public java.lang.Integer getMaxItems()

Specified by:

getMaxItems in interface SerializableParameter

setMaxItems

public void setMaxItems(java.lang.Integer maxItems)

Specified by:

setMaxItems in interface SerializableParameter

getMinItems

public java.lang.Integer getMinItems()

Specified by:

getMinItems in interface SerializableParameter

setMinItems

public void setMinItems(java.lang.Integer minItems)

Specified by:

setMinItems in interface SerializableParameter

getAllowEmptyValue

public java.lang.Boolean getAllowEmptyValue()

Specified by:

getAllowEmptyValue in interface SerializableParameter

setAllowEmptyValue

public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)

Specified by:

setAllowEmptyValue in interface SerializableParameter

getExample

public java.lang.Object getExample()

getMaxLength

public java.lang.Integer getMaxLength()

Specified by:

getMaxLength in interface SerializableParameter

setMaxLength

public void setMaxLength(java.lang.Integer maxLength)

Specified by:

setMaxLength in interface SerializableParameter

getMinLength

public java.lang.Integer getMinLength()

Specified by:

getMinLength in interface SerializableParameter

setMinLength

public void setMinLength(java.lang.Integer minLength)

Specified by:

setMinLength in interface SerializableParameter

getPattern

public java.lang.String getPattern()

Specified by:

getPattern in interface Parameter

Specified by:

getPattern in interface SerializableParameter

Overrides:

getPattern in class AbstractParameter

setPattern

public void setPattern(java.lang.String pattern)

Specified by:

setPattern in interface Parameter

Specified by:

setPattern in interface SerializableParameter

Overrides:

setPattern in class AbstractParameter

isUniqueItems

public java.lang.Boolean isUniqueItems()

Specified by:

isUniqueItems in interface SerializableParameter

setUniqueItems

public void setUniqueItems(java.lang.Boolean uniqueItems)

Specified by:

setUniqueItems in interface SerializableParameter

getMultipleOf

public java.lang.Number getMultipleOf()

Specified by:

getMultipleOf in interface SerializableParameter

setMultipleOf

public void setMultipleOf(java.lang.Number multipleOf)

Specified by:

setMultipleOf in interface SerializableParameter

isExclusiveMaximum

public java.lang.Boolean isExclusiveMaximum()

Specified by:

isExclusiveMaximum in interface SerializableParameter

setExample

public void setExample(java.lang.String example)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractParameter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractParameter