AbstractSerializableParameter (swagger-models 1.6.0 API)

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 List<String>`	`_enum`
`protected Boolean`	`allowEmptyValue`
`protected String`	`collectionFormat`
`protected String`	`defaultValue`
`protected String`	`example`
`protected Boolean`	`exclusiveMaximum`
`protected Boolean`	`exclusiveMinimum`
`protected String`	`format`
`protected Property`	`items`
`protected BigDecimal`	`maximum`
`Integer`	`maxLength` See http://json-schema.org/latest/json-schema-validation.html#anchor26
`protected BigDecimal`	`minimum`
`Integer`	`minLength` See http://json-schema.org/latest/json-schema-validation.html#anchor29
`Number`	`multipleOf` See http://json-schema.org/latest/json-schema-validation.html#anchor14
`String`	`pattern` See http://json-schema.org/latest/json-schema-validation.html#anchor33
`protected String`	`type`
`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()

Constructors
Constructor and Description
`AbstractSerializableParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`_enum(List<String> value)`
`T`	`allowEmptyValue(Boolean allowEmpty)`
`T`	`collectionFormat(String collectionFormat)`
`T`	`description(String description)`
`boolean`	`equals(Object obj)`
`T`	`example(String example)`
`T`	`format(String format)`
`Boolean`	`getAllowEmptyValue()`
`String`	`getCollectionFormat()`
`Object`	`getDefault()`
`protected String`	`getDefaultCollectionFormat()`
`Object`	`getDefaultValue()`
`List<String>`	`getEnum()`
`List<Object>`	`getEnumValue()`
`Object`	`getExample()`
`String`	`getFormat()`
`Property`	`getItems()`
`BigDecimal`	`getMaximum()`
`Integer`	`getMaxItems()`
`Integer`	`getMaxLength()`
`BigDecimal`	`getMinimum()`
`Integer`	`getMinItems()`
`Integer`	`getMinLength()`
`Number`	`getMultipleOf()`
`String`	`getPattern()`
`String`	`getType()`
`int`	`hashCode()`
`Boolean`	`isExclusiveMaximum()`
`Boolean`	`isExclusiveMinimum()`
`Boolean`	`isUniqueItems()`
`T`	`items(Property items)`
`T`	`name(String name)`
`T`	`property(Property property)`
`T`	`readOnly(Boolean readOnly)`
`T`	`required(boolean required)`
`void`	`setAllowEmptyValue(Boolean allowEmptyValue)`
`void`	`setCollectionFormat(String collectionFormat)`
`void`	`setDefault(Object defaultValue)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setEnum(List<String> _enum)`
`void`	`setEnumValue(List<?> enumValue)`
`void`	`setExample(String example)`
`void`	`setExclusiveMaximum(Boolean exclusiveMaximum)`
`void`	`setExclusiveMinimum(Boolean exclusiveMinimum)`
`void`	`setFormat(String format)`
`void`	`setItems(Property items)`
`void`	`setMaximum(BigDecimal maximum)`
`void`	`setMaxItems(Integer maxItems)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMinimum(BigDecimal minimum)`
`void`	`setMinItems(Integer minItems)`
`void`	`setMinLength(Integer minLength)`
`void`	`setMultipleOf(Number multipleOf)`
`void`	`setPattern(String pattern)`
`void`	`setProperty(Property property)`
`void`	`setType(String type)`
`void`	`setUniqueItems(Boolean uniqueItems)`
`T`	`type(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 String type
```
  - format
```
protected String format
```
  - collectionFormat
```
protected String collectionFormat
```
  - items
```
protected Property items
```
  - exclusiveMaximum
```
protected Boolean exclusiveMaximum
```
  - maximum
```
protected BigDecimal maximum
```
  - exclusiveMinimum
```
protected Boolean exclusiveMinimum
```
  - minimum
```
protected BigDecimal minimum
```
  - example
```
protected String example
```
  - allowEmptyValue
```
protected Boolean allowEmptyValue
```
  - _enum
```
protected List<String> _enum
```
  - maxLength
```
public Integer maxLength
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor26
  - minLength
```
public Integer minLength
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor29
  - pattern
```
public String pattern
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor33
  - uniqueItems
```
public Boolean uniqueItems
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor49
  - multipleOf
```
public Number multipleOf
```
    See http://json-schema.org/latest/json-schema-validation.html#anchor14
  - defaultValue
```
protected String defaultValue
```
- Constructor Detail
  - AbstractSerializableParameter
```
public AbstractSerializableParameter()
```
- Method Detail
  - property
```
public T property(Property property)
```
  - type
```
public T type(String type)
```
  - format
```
public T format(String format)
```
  - description
```
public T description(String description)
```
  - name
```
public T name(String name)
```
  - required
```
public T required(boolean required)
```
  - collectionFormat
```
public T collectionFormat(String collectionFormat)
```
  - example
```
public T example(String example)
```
  - allowEmptyValue
```
public T allowEmptyValue(Boolean allowEmpty)
```
  - readOnly
```
public T readOnly(Boolean readOnly)
```
  - getDefaultCollectionFormat
```
protected String getDefaultCollectionFormat()
```
  - items
```
public T items(Property items)
```
  - _enum
```
public T _enum(List<String> value)
```
  - getEnum
```
public List<String> getEnum()
```
    Specified by:
    
    getEnum in interface SerializableParameter
  - setEnum
```
public void setEnum(List<String> _enum)
```
    Specified by:
    
    setEnum in interface SerializableParameter
  - getEnumValue
```
public List<Object> getEnumValue()
```
    Specified by:
    
    getEnumValue in interface SerializableParameter
  - setEnumValue
```
public void setEnumValue(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 String getFormat()
```
    Specified by:
    
    getFormat in interface SerializableParameter
  - setFormat
```
public void setFormat(String format)
```
    Specified by:
    
    setFormat in interface SerializableParameter
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface SerializableParameter
  - setType
```
public void setType(String type)
```
    Specified by:
    
    setType in interface SerializableParameter
  - getCollectionFormat
```
public String getCollectionFormat()
```
    Specified by:
    
    getCollectionFormat in interface SerializableParameter
  - setCollectionFormat
```
public void setCollectionFormat(String collectionFormat)
```
    Specified by:
    
    setCollectionFormat in interface SerializableParameter
  - setProperty
```
public void setProperty(Property property)
```
  - getDefaultValue
```
public Object getDefaultValue()
```
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
  - getDefault
```
public Object getDefault()
```
  - setDefault
```
public void setDefault(Object defaultValue)
```
  - setExclusiveMaximum
```
public void setExclusiveMaximum(Boolean exclusiveMaximum)
```
    Specified by:
    
    setExclusiveMaximum in interface SerializableParameter
  - getMaximum
```
public BigDecimal getMaximum()
```
    Specified by:
    
    getMaximum in interface SerializableParameter
  - setMaximum
```
public void setMaximum(BigDecimal maximum)
```
    Specified by:
    
    setMaximum in interface SerializableParameter
  - isExclusiveMinimum
```
public Boolean isExclusiveMinimum()
```
    Specified by:
    
    isExclusiveMinimum in interface SerializableParameter
  - setExclusiveMinimum
```
public void setExclusiveMinimum(Boolean exclusiveMinimum)
```
    Specified by:
    
    setExclusiveMinimum in interface SerializableParameter
  - getMinimum
```
public BigDecimal getMinimum()
```
    Specified by:
    
    getMinimum in interface SerializableParameter
  - setMinimum
```
public void setMinimum(BigDecimal minimum)
```
    Specified by:
    
    setMinimum in interface SerializableParameter
  - getMaxItems
```
public Integer getMaxItems()
```
    Specified by:
    
    getMaxItems in interface SerializableParameter
  - setMaxItems
```
public void setMaxItems(Integer maxItems)
```
    Specified by:
    
    setMaxItems in interface SerializableParameter
  - getMinItems
```
public Integer getMinItems()
```
    Specified by:
    
    getMinItems in interface SerializableParameter
  - setMinItems
```
public void setMinItems(Integer minItems)
```
    Specified by:
    
    setMinItems in interface SerializableParameter
  - getAllowEmptyValue
```
public Boolean getAllowEmptyValue()
```
    Specified by:
    
    getAllowEmptyValue in interface SerializableParameter
  - setAllowEmptyValue
```
public void setAllowEmptyValue(Boolean allowEmptyValue)
```
    Specified by:
    
    setAllowEmptyValue in interface SerializableParameter
  - getExample
```
public Object getExample()
```
  - getMaxLength
```
public Integer getMaxLength()
```
    Specified by:
    
    getMaxLength in interface SerializableParameter
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
    Specified by:
    
    setMaxLength in interface SerializableParameter
  - getMinLength
```
public Integer getMinLength()
```
    Specified by:
    
    getMinLength in interface SerializableParameter
  - setMinLength
```
public void setMinLength(Integer minLength)
```
    Specified by:
    
    setMinLength in interface SerializableParameter
  - getPattern
```
public String getPattern()
```
    Specified by:
    
    getPattern in interface Parameter
    
    Specified by:
    
    getPattern in interface SerializableParameter
    
    Overrides:
    
    getPattern in class AbstractParameter
  - setPattern
```
public void setPattern(String pattern)
```
    Specified by:
    
    setPattern in interface Parameter
    
    Specified by:
    
    setPattern in interface SerializableParameter
    
    Overrides:
    
    setPattern in class AbstractParameter
  - isUniqueItems
```
public Boolean isUniqueItems()
```
    Specified by:
    
    isUniqueItems in interface SerializableParameter
  - setUniqueItems
```
public void setUniqueItems(Boolean uniqueItems)
```
    Specified by:
    
    setUniqueItems in interface SerializableParameter
  - getMultipleOf
```
public Number getMultipleOf()
```
    Specified by:
    
    getMultipleOf in interface SerializableParameter
  - setMultipleOf
```
public void setMultipleOf(Number multipleOf)
```
    Specified by:
    
    setMultipleOf in interface SerializableParameter
  - isExclusiveMaximum
```
public Boolean isExclusiveMaximum()
```
    Specified by:
    
    isExclusiveMaximum in interface SerializableParameter
  - setExample
```
public void setExample(String example)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractParameter
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractParameter

Class AbstractSerializableParameter<T extends AbstractSerializableParameter<T>>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

type

format

collectionFormat

items

exclusiveMaximum

maximum

exclusiveMinimum

minimum

example

allowEmptyValue

_enum

maxLength

minLength

pattern

uniqueItems

multipleOf

defaultValue

Constructor Detail

AbstractSerializableParameter

Method Detail

property

type

format

description

name

required

collectionFormat

example

allowEmptyValue

readOnly

getDefaultCollectionFormat

items

_enum

getEnum

setEnum

getEnumValue

setEnumValue

getItems

setItems

getFormat

setFormat

getType

setType

getCollectionFormat

setCollectionFormat

setProperty

getDefaultValue

setDefaultValue

getDefault

setDefault

setExclusiveMaximum

getMaximum

setMaximum

isExclusiveMinimum

setExclusiveMinimum

getMinimum

setMinimum

getMaxItems

setMaxItems

getMinItems

setMinItems

getAllowEmptyValue

setAllowEmptyValue

getExample

getMaxLength

setMaxLength

getMinLength

setMinLength

getPattern

setPattern

isUniqueItems