com.wordnik.swagger.models.parameters

Class HeaderParameter

java.lang.Object

com.wordnik.swagger.models.parameters.AbstractParameter

com.wordnik.swagger.models.parameters.HeaderParameter

All Implemented Interfaces:

Parameter, SerializableParameter

public class HeaderParameter
extends AbstractParameter
implements SerializableParameter

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	_enum
protected String	collectionFormat
protected String	defaultValue
protected String	format
protected Property	items
protected String	type

Fields inherited from class com.wordnik.swagger.models.parameters.AbstractParameter

access, description, in, name, pattern, required

Constructor Summary

Constructors

Constructor and Description
HeaderParameter()

Method Summary

Methods

Modifier and Type	Method and Description
HeaderParameter	_enum(List<String> value)
HeaderParameter	array(boolean isArray)
HeaderParameter	collectionFormat(String collectionFormat)
HeaderParameter	description(String description)
String	getCollectionFormat()
String	getDefaultValue()
List<String>	getEnum()
String	getFormat()
Property	getItems()
String	getType()
HeaderParameter	items(Property items)
HeaderParameter	name(String name)
HeaderParameter	property(Property property)
void	setArray(boolean isArray)
void	setCollectionFormat(String collectionFormat)
void	setDefaultValue(String defaultValue)
void	setEnum(List<String> _enum)
void	setFormat(String format)
void	setItems(Property items)
void	setProperty(Property property)
void	setType(String type)

Methods inherited from class com.wordnik.swagger.models.parameters.AbstractParameter

getAccess, getDescription, getIn, getName, getPattern, getRequired, getVendorExtensions, setAccess, setDescription, setIn, setName, setPattern, setRequired, setVendorExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.wordnik.swagger.models.parameters.Parameter

getAccess, getDescription, getIn, getName, getPattern, getRequired, getVendorExtensions, setAccess, setDescription, setIn, setName, setPattern, setRequired

Field Detail

type

protected String type

format

protected String format

collectionFormat

protected String collectionFormat

items

protected Property items

defaultValue

protected String defaultValue

_enum

protected List<String> _enum

Constructor Detail

HeaderParameter

public HeaderParameter()

Method Detail

property

public HeaderParameter property(Property property)

description

public HeaderParameter description(String description)

name

public HeaderParameter name(String name)

collectionFormat

public HeaderParameter collectionFormat(String collectionFormat)

array

public HeaderParameter array(boolean isArray)

items

public HeaderParameter items(Property items)

_enum

public HeaderParameter _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

setArray

public void setArray(boolean isArray)

setItems

public void setItems(Property items)

Specified by:

setItems in interface SerializableParameter

getItems

public Property getItems()

Specified by:

getItems 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

getFormat

public String getFormat()

Specified by:

getFormat in interface SerializableParameter

setFormat

public void setFormat(String format)

Specified by:

setFormat 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 String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)