org.restdoc.api

Class HeaderDefinition

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.HeaderDefinition

public class HeaderDefinition
extends RestDocObject

Author:

hoegertn

Field Summary

Fields inherited from class org.restdoc.api.util.RestDocObject

additionalFields

Constructor Summary

Constructors

Constructor and Description
HeaderDefinition()
HeaderDefinition(String description)
HeaderDefinition(String description, boolean required)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
boolean	isRequired()
void	setDescription(String description)
void	setRequired(boolean required)

Methods inherited from class org.restdoc.api.util.RestDocObject

getAdditionalBoolean, getAdditionalField, getAdditionalFields, getAdditionalNumber, getAdditionalString, setAdditionalField

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderDefinition

public HeaderDefinition()

HeaderDefinition

public HeaderDefinition(String description)

Parameters:

description -

HeaderDefinition

public HeaderDefinition(String description,
                boolean required)

Parameters:

description -

required -

Method Detail

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

isRequired

public boolean isRequired()

Returns:

the required

setRequired

public void setRequired(boolean required)

Parameters:

required - the required to set