HeaderInfo (Apache Juneau 7.1.1)

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

```
@Bean(properties="description,type,format,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf,*")
public class HeaderInfo
extends SwaggerElement
```
Describes a single HTTP header.
Example:

// Construct using SwaggerBuilder. HeaderInfo x = headerInfo("integer").description("The number of allowed requests in the current period"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "description": "The number of allowed requests in the current period", "type": "integer" }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

HeaderInfo()

Constructors
Constructor and Description
`HeaderInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HeaderInfo`	`_default(Object value)` Same as `setDefault(Object)`.
`HeaderInfo`	`_enum(Object... values)` Adds one or more values to the enum property.
`HeaderInfo`	`addEnum(Collection<Object> values)` Adds one or more values to the enum property.
`HeaderInfo`	`collectionFormat(Object value)` Same as `setCollectionFormat(String)`.
`HeaderInfo`	`description(Object value)` Same as `setDescription(String)`.
`HeaderInfo`	`exclusiveMaximum(Object value)` Same as `setExclusiveMaximum(Boolean)`.
`HeaderInfo`	`exclusiveMinimum(Object value)` Same as `setExclusiveMinimum(Boolean)`.
`HeaderInfo`	`format(Object value)` Same as `setFormat(String)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`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.
`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`	`getPattern()` Bean property getter: pattern.
`String`	`getType()` Bean property getter: type.
`Boolean`	`getUniqueItems()` Bean property getter: uniqueItems.
`HeaderInfo`	`items(Object value)` Same as `setItems(Items)`.
`HeaderInfo`	`maximum(Object value)` Same as `setMaximum(Number)`.
`HeaderInfo`	`maxItems(Object value)` Same as `setMaxItems(Integer)`.
`HeaderInfo`	`maxLength(Object value)` Same as `setMaxLength(Integer)`.
`HeaderInfo`	`minimum(Object value)` Same as `setMinimum(Number)`.
`HeaderInfo`	`minItems(Object value)` Same as `setMinItems(Integer)`.
`HeaderInfo`	`minLength(Object value)` Same as `setMinLength(Integer)`.
`HeaderInfo`	`multipleOf(Object value)` Same as `setMultipleOf(Number)`.
`HeaderInfo`	`pattern(Object value)` Same as `setPattern(String)`.
`HeaderInfo`	`set(String property, Object value)` Generic property setter.
`HeaderInfo`	`setCollectionFormat(String value)` Bean property setter: collectionFormat.
`HeaderInfo`	`setDefault(Object value)` Bean property setter: default.
`HeaderInfo`	`setDescription(String value)` Bean property setter: description.
`HeaderInfo`	`setEnum(Collection<Object> value)` Bean property setter: enum.
`HeaderInfo`	`setExclusiveMaximum(Boolean value)` Bean property setter: exclusiveMaximum.
`HeaderInfo`	`setExclusiveMinimum(Boolean value)` Bean property setter: exclusiveMinimum.
`HeaderInfo`	`setFormat(String value)` Bean property setter: format.
`HeaderInfo`	`setItems(Items value)` Bean property setter: items.
`HeaderInfo`	`setMaximum(Number value)` Bean property setter: maximum.
`HeaderInfo`	`setMaxItems(Integer value)` Bean property setter: maxItems.
`HeaderInfo`	`setMaxLength(Integer value)` Bean property setter: maxLength.
`HeaderInfo`	`setMinimum(Number value)` Bean property setter: minimum.
`HeaderInfo`	`setMinItems(Integer value)` Bean property setter: minItems.
`HeaderInfo`	`setMinLength(Integer value)` Bean property setter: minLength.
`HeaderInfo`	`setMultipleOf(Number value)` Bean property setter: multipleOf.
`HeaderInfo`	`setPattern(String value)` Bean property setter: pattern.
`HeaderInfo`	`setType(String value)` Bean property setter: type.
`HeaderInfo`	`setUniqueItems(Boolean value)` Bean property setter: uniqueItems.
`protected HeaderInfo`	`strict()` Sets strict mode on this bean.
`HeaderInfo`	`type(Object value)` Same as `setType(String)`.
`HeaderInfo`	`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
  - HeaderInfo
```
public HeaderInfo()
```
- Method Detail
  - strict
```
protected HeaderInfo strict()
```
    Description copied from class: SwaggerElement
    
    Sets strict mode on this bean.
    
    Overrides:
    
    strict in class SwaggerElement
    
    Returns:
    
    This object (for method chaining).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A short description of the header.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public HeaderInfo setDescription(String value)
```
    Bean property setter: description.
    A short description of the header.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public HeaderInfo description(Object value)
```
    Same as setDescription(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).
  - getType
```
public String getType()
```
    Bean property getter: type.
    The type of the object.
    
    Returns:
    
    The property value, or null if it is not set.
  - setType
```
public HeaderInfo setType(String value)
```
    Bean property setter: type.
    The type of the object.
    Parameters:
    value - The new value for this property.
    Property value is required.
    Valid values:
    
    "string"
    "number"
    "integer"
    "boolean"
    "array"
    Returns:
    
    This object (for method chaining).
  - type
```
public HeaderInfo 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().
    Can be null to unset the property.
    
    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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - format
```
public HeaderInfo 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).
  - 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 HeaderInfo 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 HeaderInfo items(Object value)
```
    Same as setItems(Items).
    Parameters:
    value - The new value for this property.
    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 HeaderInfo 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.
    Returns:
    
    This object (for method chaining).
  - collectionFormat
```
public HeaderInfo 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().
    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 header that the server will use if none is provided.
    Notes:
    - "default" has no meaning for required items.
    - Unlike JSON Schema this value MUST conform to the defined type for the header.
    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 HeaderInfo setDefault(Object value)
```
    Bean property setter: default.
    Declares the value of the header that the server will use if none is provided.
    Notes:
    - "default" has no meaning for required items.
    - Unlike JSON Schema this value MUST conform to the defined type for the header.
    See Also:
    - http://json-schema.org/latest/json-schema-validation.html#anchor101
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - _default
```
public HeaderInfo _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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - maximum
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - exclusiveMaximum
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - minimum
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - exclusiveMinimum
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - maxLength
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - minLength
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - pattern
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - maxItems
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - minItems
```
public HeaderInfo 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 HeaderInfo 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.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - uniqueItems
```
public HeaderInfo 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 HeaderInfo 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 HeaderInfo addEnum(Collection<Object> values)
```
    Adds one or more values to the enum property.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - _enum
```
public HeaderInfo _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 HeaderInfo 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 HeaderInfo 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 HeaderInfo 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 HeaderInfo

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

HeaderInfo

Method Detail

strict

getDescription

setDescription

description

getType

setType

type

getFormat

See Also:

setFormat

See Also:

format

getItems

setItems

items

Example:

getCollectionFormat

setCollectionFormat

collectionFormat

getDefault

Notes:

See Also:

setDefault

Notes:

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

getMinLength

See Also:

setMinLength

See Also:

minLength

getPattern

See Also:

setPattern

See Also:

pattern

getMaxItems

See Also:

setMaxItems

See Also:

maxItems

getMinItems

See Also:

setMinItems

See Also: