ParameterInfo (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.ParameterInfo

```
@Bean(properties="in,name,type,description,required,schema,format,allowEmptyValue,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf,*")
public class ParameterInfo
extends SwaggerElement
```
Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
There are five possible parameter types.
- "path" - Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
- "query" - Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
- "header" - Custom headers that are expected as part of the request.
- "body" - The payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.
- "formData" - Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded, multipart/form-data or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation). This is the only parameter type that can be used to send files, thus supporting the file type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
  - "application/x-www-form-urlencoded" - Similar to the format of Query parameters but as a payload. For example, foo=1&bar=swagger - both foo and bar are form parameters. This is normally used for simple parameters that are being transferred.
  - "multipart/form-data" - each parameter takes a section in the payload with an internal header. For example, for the header Content-Disposition: form-data; name="submit-name" the name of the parameter is submit-name. This type of form parameters is more commonly used for file transfers.
Example:

// Construct using SwaggerBuilder. ParameterInfo x = parameterInfo("query", "foo"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "in": "query", "name": "foo" }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

ParameterInfo()

Constructors
Constructor and Description
`ParameterInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParameterInfo`	`_default(Object value)` Same as `setDefault(Object)`.
`ParameterInfo`	`_enum(Object... values)` Adds one or more values to the enum property.
`ParameterInfo`	`addEnum(Collection<Object> value)` Adds one or more values to the enum property.
`ParameterInfo`	`allowEmptyValue(Object value)` Same as `setAllowEmptyValue(Boolean)`.
`ParameterInfo`	`collectionFormat(Object value)` Same as `setCollectionFormat(String)`.
`ParameterInfo`	`copyFrom(ParameterInfo p)` Copies any non-null fields from the specified object to this object.
`ParameterInfo`	`description(Object value)` Same as `setDescription(String)`.
`ParameterInfo`	`exclusiveMaximum(Object value)` Same as `setExclusiveMaximum(Boolean)`.
`ParameterInfo`	`exclusiveMinimum(Object value)` Same as `setExclusiveMinimum(Boolean)`.
`ParameterInfo`	`format(Object value)` Same as `setFormat(String)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`Boolean`	`getAllowEmptyValue()` Bean property getter: allowEmptyValue.
`String`	`getCollectionFormat()` Bean property getter: collectionFormat.
`Object`	`getDefault()` Bean property getter: default.
`String`	`getDescription()` Bean property getter: description.
`List<Object>`	`getEnum()` Bean property getter: enum.
`Boolean`	`getExclusiveMaximum()` Bean property getter: exclusiveMaximum.
`Boolean`	`getExclusiveMinimum()` Bean property getter: exclusiveMinimum.
`String`	`getFormat()` Bean property getter: format.
`String`	`getIn()` Bean property getter: in.
`Items`	`getItems()` Bean property getter: items.
`Number`	`getMaximum()` Bean property getter: maximum.
`Integer`	`getMaxItems()` Bean property getter: maxItems.
`Integer`	`getMaxLength()` Bean property getter: maxLength.
`Number`	`getMinimum()` Bean property getter: minimum.
`Integer`	`getMinItems()` Bean property getter: minItems.
`Integer`	`getMinLength()` Bean property getter: minLength.
`Number`	`getMultipleOf()` Bean property getter: multipleOf.
`String`	`getName()` Bean property getter: name.
`String`	`getPattern()` Bean property getter: pattern.
`Boolean`	`getRequired()` Bean property getter: required.
`SchemaInfo`	`getSchema()` Bean property getter: schema.
`String`	`getType()` Bean property getter: type.
`Boolean`	`getUniqueItems()` Bean property getter: uniqueItems.
`ParameterInfo`	`in(Object value)` Same as `setIn(String)`.
`ParameterInfo`	`items(Object value)` Same as `setItems(Items)`.
`ParameterInfo`	`maximum(Object value)` Same as `setMaximum(Number)`.
`ParameterInfo`	`maxItems(Object value)` Same as `setMaxItems(Integer)`.
`ParameterInfo`	`maxLength(Object value)` Same as `setMaxLength(Integer)`.
`ParameterInfo`	`minimum(Object value)` Same as `setMinimum(Number)`.
`ParameterInfo`	`minItems(Object value)` Same as `setMinItems(Integer)`.
`ParameterInfo`	`minLength(Object value)` Same as `setMinLength(Integer)`.
`ParameterInfo`	`multipleOf(Object value)` Same as `setMultipleOf(Number)`.
`ParameterInfo`	`name(Object value)` Same as `setName(String)`.
`ParameterInfo`	`pattern(Object value)` Same as `setPattern(String)`.
`ParameterInfo`	`required(Object value)` Same as `setRequired(Boolean)`.
`ParameterInfo`	`schema(Object value)` Same as `setSchema(SchemaInfo)`.
`ParameterInfo`	`set(String property, Object value)` Generic property setter.
`ParameterInfo`	`setAllowEmptyValue(Boolean value)` Bean property setter: allowEmptyValue.
`ParameterInfo`	`setCollectionFormat(String value)` Bean property setter: collectionFormat.
`ParameterInfo`	`setDefault(Object value)` Bean property setter: default.
`ParameterInfo`	`setDescription(String value)` Bean property setter: description.
`ParameterInfo`	`setEnum(Collection<Object> value)` Bean property setter: enum.
`ParameterInfo`	`setExclusiveMaximum(Boolean value)` Bean property setter: exclusiveMaximum.
`ParameterInfo`	`setExclusiveMinimum(Boolean value)` Bean property setter: exclusiveMinimum.
`ParameterInfo`	`setFormat(String value)` Bean property setter: format.
`ParameterInfo`	`setIn(String value)` Bean property setter: in.
`ParameterInfo`	`setItems(Items value)` Bean property setter: items.
`ParameterInfo`	`setMaximum(Number value)` Bean property setter: maximum.
`ParameterInfo`	`setMaxItems(Integer value)` Bean property setter: maxItems.
`ParameterInfo`	`setMaxLength(Integer value)` Bean property setter: maxLength.
`ParameterInfo`	`setMinimum(Number value)` Bean property setter: minimum.
`ParameterInfo`	`setMinItems(Integer value)` Bean property setter: minItems.
`ParameterInfo`	`setMinLength(Integer value)` Bean property setter: minLength.
`ParameterInfo`	`setMultipleOf(Number value)` Bean property setter: multipleOf.
`ParameterInfo`	`setName(String value)` Bean property setter: name.
`ParameterInfo`	`setPattern(String value)` Bean property setter: pattern.
`ParameterInfo`	`setRequired(Boolean value)` Bean property setter: required.
`ParameterInfo`	`setSchema(SchemaInfo value)` Bean property setter: schema.
`ParameterInfo`	`setType(String value)` Bean property setter: type.
`ParameterInfo`	`setUniqueItems(Boolean value)` Bean property setter: uniqueItems.
`protected ParameterInfo`	`strict()` Sets strict mode on this bean.
`ParameterInfo`	`type(Object value)` Same as `setType(String)`.
`ParameterInfo`	`uniqueItems(Object value)` Same as `setUniqueItems(Boolean)`.

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement
getExtraProperties, isStrict, strict, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ParameterInfo
```
public ParameterInfo()
```
- Method Detail
  - strict
```
protected ParameterInfo strict()
```
    Description copied from class: SwaggerElement
    
    Sets strict mode on this bean.
    
    Overrides:
    
    strict in class SwaggerElement
    
    Returns:
    
    This object (for method chaining).
  - copyFrom
```
public ParameterInfo copyFrom(ParameterInfo p)
```
    Copies any non-null fields from the specified object to this object.
    
    Parameters:
    
    p - The object to copy fields from.
    Can be null.
    
    Returns:
    
    This object (for method chaining).
  - getName
```
public String getName()
```
    Bean property getter: name.
    The name of the parameter.
    Notes:
    - Parameter names are case sensitive.
    - If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object.
    - For all other cases, the name corresponds to the parameter name used based on the in property.
    See Also:
    - Path Templating
    Returns:
    
    The property value, or null if it is not set.
  - setName
```
public ParameterInfo setName(String value)
```
    Bean property setter: name.
    The name of the parameter.
    Notes:
    - Parameter names are case sensitive.
    - If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object.
    - For all other cases, the name corresponds to the parameter name used based on the in property.
    See Also:
    - Path Templating
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - name
```
public ParameterInfo name(Object value)
```
    Same as setName(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getIn
```
public String getIn()
```
    Bean property getter: in.
    The location of the parameter.
    
    Returns:
    
    The property value, or null if it is not set.
  - setIn
```
public ParameterInfo setIn(String value)
```
    Bean property setter: in.
    The location of the parameter.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "query"
    "header"
    "path"
    "formData"
    "body"
    
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - in
```
public ParameterInfo in(Object value)
```
    Same as setIn(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "query"
    "header"
    "path"
    "formData"
    "body"
    
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A brief description of the parameter.
    This could contain examples of use.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public ParameterInfo setDescription(String value)
```
    Bean property setter: description.
    A brief description of the parameter.
    This could contain examples of use.
    
    Parameters:
    
    value - The new value for this property.
    GFM syntax can be used for rich text representation.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public ParameterInfo description(Object value)
```
    Same as setDescription(String).
    
    Parameters:
    
    value - The new value for this property.
    GFM syntax can be used for rich text representation.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getRequired
```
public Boolean getRequired()
```
    Bean property getter: required.
    Determines whether this parameter is mandatory.
    
    Returns:
    
    The property value, or null if it is not set.
  - setRequired
```
public ParameterInfo setRequired(Boolean value)
```
    Bean property setter: required.
    Determines whether this parameter is mandatory.
    
    Parameters:
    
    value - The new value for this property.
    If the parameter is in "path", this property is required and its value MUST be true.
    Otherwise, the property MAY be included and its default value is false.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - required
```
public ParameterInfo required(Object value)
```
    Same as setRequired(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    If the parameter is in "path", this property is required and its value MUST be true.
    Otherwise, the property MAY be included and its default value is false.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getSchema
```
public SchemaInfo getSchema()
```
    Bean property getter: schema.
    The schema defining the type used for the body parameter.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSchema
```
public ParameterInfo setSchema(SchemaInfo value)
```
    Bean property setter: schema.
    The schema defining the type used for the body parameter.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - schema
```
public ParameterInfo schema(Object value)
```
    Same as setSchema(SchemaInfo).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    SchemaInfo
    String - JSON object representation of SchemaInfo
    Example:
    
    schema("{type:'type',description:'description',...}");
    
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - getType
```
public String getType()
```
    Bean property getter: type.
    The type of the parameter.
    
    Returns:
    
    The property value, or null if it is not set.
  - setType
```
public ParameterInfo setType(String value)
```
    Bean property setter: type.
    The type of the parameter.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "string"
    "number"
    "integer"
    "boolean"
    "array"
    "file"
    
    If type is "file", the consumes MUST be either "multipart/form-data", "application/x-www-form-urlencoded" or both and the parameter MUST be in "formData".
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - type
```
public ParameterInfo type(Object value)
```
    Same as setType(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "string"
    "number"
    "integer"
    "boolean"
    "array"
    "file"
    
    If type is "file", the consumes MUST be either "multipart/form-data", "application/x-www-form-urlencoded" or both and the parameter MUST be in "formData".
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - getFormat
```
public String getFormat()
```
    Bean property getter: format.
    The extending format for the previously mentioned type.
    See Also:
    - Data Type Formats
    Returns:
    
    The property value, or null if it is not set.
  - setFormat
```
public ParameterInfo setFormat(String value)
```
    Bean property setter: format.
    The extending format for the previously mentioned type.
    See Also:
    - Data Type Formats
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - format
```
public ParameterInfo format(Object value)
```
    Same as setFormat(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getAllowEmptyValue
```
public Boolean getAllowEmptyValue()
```
    Bean property getter: allowEmptyValue.
    Sets the ability to pass empty-valued parameters.
    This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value.
    
    Returns:
    
    The property value, or null if it is not set.
  - setAllowEmptyValue
```
public ParameterInfo setAllowEmptyValue(Boolean value)
```
    Bean property setter: allowEmptyValue.
    Sets the ability to pass empty-valued parameters.
    This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    Default is false.
    
    Returns:
    
    This object (for method chaining).
  - allowEmptyValue
```
public ParameterInfo allowEmptyValue(Object value)
```
    Same as setAllowEmptyValue(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    Default is false.
    
    Returns:
    
    This object (for method chaining).
  - getItems
```
public Items getItems()
```
    Bean property getter: items.
    Describes the type of items in the array.
    
    Returns:
    
    The property value, or null if it is not set.
  - setItems
```
public ParameterInfo setItems(Items value)
```
    Bean property setter: items.
    Describes the type of items in the array.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required if type is "array".
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - items
```
public ParameterInfo items(Object value)
```
    Same as setItems(Items).
    Parameters:
    value - The new value for this property.
    Property value is required if type is "array".
    Valid types:
    
    Items
    String - JSON object representation of Items
    Example:
    
    items("{type:'type',format:'format',...}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getCollectionFormat
```
public String getCollectionFormat()
```
    Bean property getter: collectionFormat.
    Determines the format of the array if type array is used.
    
    Returns:
    
    The property value, or null if it is not set.
  - setCollectionFormat
```
public ParameterInfo setCollectionFormat(String value)
```
    Bean property setter: collectionFormat.
    Determines the format of the array if type array is used.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "csv" (default) - comma separated values foo,bar.
    "ssv" - space separated values foo bar.
    "tsv" - tab separated values foo\tbar.
    "pipes" - pipe separated values foo|bar.
    "multi" - corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
    This is valid only for parameters in "query" or "formData".
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - collectionFormat
```
public ParameterInfo collectionFormat(Object value)
```
    Same as setCollectionFormat(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "csv" (default) - comma separated values foo,bar.
    "ssv" - space separated values foo bar.
    "tsv" - tab separated values foo\tbar.
    "pipes" - pipe separated values foo|bar.
    "multi" - corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
    This is valid only for parameters in "query" or "formData".
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getDefault
```
public Object getDefault()
```
    Bean property getter: default.
    Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor101
    Returns:
    
    The property value, or null if it is not set.
  - setDefault
```
public ParameterInfo setDefault(Object value)
```
    Bean property setter: default.
    Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor101
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - _default
```
public ParameterInfo _default(Object value)
```
    Same as setDefault(Object).
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - getMaximum
```
public Number getMaximum()
```
    Bean property getter: maximum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor17
    Returns:
    
    The property value, or null if it is not set.
  - setMaximum
```
public ParameterInfo setMaximum(Number value)
```
    Bean property setter: maximum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor17
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - maximum
```
public ParameterInfo maximum(Object value)
```
    Same as setMaximum(Number).
    
    Parameters:
    
    value - The new value for this property.
    Non-Number values will be converted to Number using toString() then best number match.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getExclusiveMaximum
```
public Boolean getExclusiveMaximum()
```
    Bean property getter: exclusiveMaximum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor17
    Returns:
    
    The property value, or null if it is not set.
  - setExclusiveMaximum
```
public ParameterInfo setExclusiveMaximum(Boolean value)
```
    Bean property setter: exclusiveMaximum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor17
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - exclusiveMaximum
```
public ParameterInfo exclusiveMaximum(Object value)
```
    Same as setExclusiveMaximum(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getMinimum
```
public Number getMinimum()
```
    Bean property getter: minimum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor21
    Returns:
    
    The property value, or null if it is not set.
  - setMinimum
```
public ParameterInfo setMinimum(Number value)
```
    Bean property setter: minimum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor21
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - minimum
```
public ParameterInfo minimum(Object value)
```
    Same as setMinimum(Number).
    
    Parameters:
    
    value - The new value for this property.
    Non-Number values will be converted to Number using toString() then best number match.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getExclusiveMinimum
```
public Boolean getExclusiveMinimum()
```
    Bean property getter: exclusiveMinimum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor21
    Returns:
    
    The property value, or null if it is not set.
  - setExclusiveMinimum
```
public ParameterInfo setExclusiveMinimum(Boolean value)
```
    Bean property setter: exclusiveMinimum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor21
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - exclusiveMinimum
```
public ParameterInfo exclusiveMinimum(Object value)
```
    Same as setExclusiveMinimum(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getMaxLength
```
public Integer getMaxLength()
```
    Bean property getter: maxLength.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor26
    Returns:
    
    The property value, or null if it is not set.
  - setMaxLength
```
public ParameterInfo setMaxLength(Integer value)
```
    Bean property setter: maxLength.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor26
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - maxLength
```
public ParameterInfo maxLength(Object value)
```
    Same as setMaxLength(Integer).
    
    Parameters:
    
    value - The new value for this property.
    Non-Integer values will be converted to Integer using Integer.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getMinLength
```
public Integer getMinLength()
```
    Bean property getter: minLength.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor29
    Returns:
    
    The property value, or null if it is not set.
  - setMinLength
```
public ParameterInfo setMinLength(Integer value)
```
    Bean property setter: minLength.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor29
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - minLength
```
public ParameterInfo minLength(Object value)
```
    Same as setMinLength(Integer).
    
    Parameters:
    
    value - The new value for this property.
    Non-Integer values will be converted to Integer using Integer.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getPattern
```
public String getPattern()
```
    Bean property getter: pattern.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor33
    Returns:
    
    The property value, or null if it is not set.
  - setPattern
```
public ParameterInfo setPattern(String value)
```
    Bean property setter: pattern.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor33
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - pattern
```
public ParameterInfo pattern(Object value)
```
    Same as setPattern(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getMaxItems
```
public Integer getMaxItems()
```
    Bean property getter: maxItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor42
    Returns:
    
    The property value, or null if it is not set.
  - setMaxItems
```
public ParameterInfo setMaxItems(Integer value)
```
    Bean property setter: maxItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor42
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - maxItems
```
public ParameterInfo maxItems(Object value)
```
    Same as setMaxItems(Integer).
    
    Parameters:
    
    value - The new value for this property.
    Non-Integer values will be converted to Integer using Integer.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getMinItems
```
public Integer getMinItems()
```
    Bean property getter: minItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor45
    Returns:
    
    The property value, or null if it is not set.
  - setMinItems
```
public ParameterInfo setMinItems(Integer value)
```
    Bean property setter: minItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor45
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - minItems
```
public ParameterInfo minItems(Object value)
```
    Same as setMinItems(Integer).
    
    Parameters:
    
    value - The new value for this property.
    Non-Integer values will be converted to Integer using Integer.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getUniqueItems
```
public Boolean getUniqueItems()
```
    Bean property getter: uniqueItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor49
    Returns:
    
    The property value, or null if it is not set.
  - setUniqueItems
```
public ParameterInfo setUniqueItems(Boolean value)
```
    Bean property setter: uniqueItems.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor49
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - uniqueItems
```
public ParameterInfo uniqueItems(Object value)
```
    Same as setUniqueItems(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getEnum
```
public List<Object> getEnum()
```
    Bean property getter: enum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor76
    Returns:
    
    The property value, or null if it is not set.
  - setEnum
```
public ParameterInfo setEnum(Collection<Object> value)
```
    Bean property setter: enum.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor76
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addEnum
```
public ParameterInfo addEnum(Collection<Object> value)
```
    Adds one or more values to the enum property.
    
    Parameters:
    
    value - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - _enum
```
public ParameterInfo _enum(Object... values)
```
    Adds one or more values to the enum property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Object
    Collection<Object>
    String - JSON array representation of Collection<Object>
    Example:
    
    _enum("['foo','bar']");
    
    String - Individual values
    Example:
    
    _enum("foo", "bar");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getMultipleOf
```
public Number getMultipleOf()
```
    Bean property getter: multipleOf.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor14
    Returns:
    
    The property value, or null if it is not set.
  - setMultipleOf
```
public ParameterInfo setMultipleOf(Number value)
```
    Bean property setter: multipleOf.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor14
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - multipleOf
```
public ParameterInfo multipleOf(Object value)
```
    Same as setMultipleOf(Number).
    
    Parameters:
    
    value - The new value for this property.
    Non-Number values will be converted to Number using toString() then best number match.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - get
```
public <T> T get(String property,
                 Class<T> type)
```
    Description copied from class: SwaggerElement
    
    Generic property getter.
    Can be used to retrieve non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    get in class SwaggerElement
    
    Parameters:
    
    property - The property name to retrieve.
    
    type - The datatype to cast the value to.
    
    Returns:
    
    The property value, or null if the property does not exist or is not set.
  - set
```
public ParameterInfo set(String property,
                         Object value)
```
    Description copied from class: SwaggerElement
    
    Generic property setter.
    Can be used to set non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    set in class SwaggerElement
    
    Parameters:
    
    property - The property name to set.
    
    value - The new value for the property.
    
    Returns:
    
    This object (for method chaining).

Class ParameterInfo

Example:

See Also:

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

Methods inherited from class java.lang.Object

Constructor Detail

ParameterInfo

Method Detail

strict

copyFrom

getName

Notes:

See Also:

setName

Notes:

See Also:

name

getIn

setIn

in

getDescription

setDescription

description

getRequired

setRequired

required

getSchema

setSchema

schema

Example:

getType

setType

type

getFormat

See Also:

setFormat

See Also:

format

getAllowEmptyValue

setAllowEmptyValue

allowEmptyValue

getItems

setItems

items

Example:

getCollectionFormat

setCollectionFormat

collectionFormat

getDefault

See Also:

setDefault

See Also:

_default

getMaximum

See Also:

setMaximum

See Also:

maximum

getExclusiveMaximum

See Also:

setExclusiveMaximum

See Also:

exclusiveMaximum

getMinimum

See Also:

setMinimum

See Also:

minimum

getExclusiveMinimum

See Also:

setExclusiveMinimum

See Also:

exclusiveMinimum

getMaxLength

See Also:

setMaxLength

See Also:

maxLength