public class HeaderDescriptor extends AbstractDescriptor<HeaderDescriptor>
HeaderDocumentation.headerWithName(String)
Modifier | Constructor and Description |
---|---|
protected |
HeaderDescriptor(String name)
Creates a new
HeaderDescriptor describing the header with the given
name . |
Modifier and Type | Method and Description |
---|---|
String |
getName()
Returns the name for the header.
|
boolean |
isOptional()
Returns
true if the described header is optional, otherwise false . |
HeaderDescriptor |
optional()
Marks the header as optional.
|
attributes, description, getAttributes, getDescription
protected HeaderDescriptor(String name)
HeaderDescriptor
describing the header with the given
name
.name
- the nameHttpHeaders
public final HeaderDescriptor optional()
this
public final String getName()
public final boolean isOptional()
true
if the described header is optional, otherwise false
.true
if the described header is optional, otherwise false