Package org.springframework.restdocs.headers

Class HeaderDescriptor

java.lang.Object

org.springframework.restdocs.snippet.AbstractDescriptor<HeaderDescriptor>

org.springframework.restdocs.headers.HeaderDescriptor

public class HeaderDescriptor
extends AbstractDescriptor<HeaderDescriptor>

A description of a header found in a request or response.

Author:

Andreas Evers

See Also:

• HeaderDocumentation.headerWithName(String)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderDescriptor(String name)	Creates a new HeaderDescriptor describing the header with the given name.

Method Summary

Modifier and Type	Method	Description
final String	getName()	Returns the name for the header.
final boolean	isOptional()	Returns true if the described header is optional, otherwise false.
final HeaderDescriptor	optional()	Marks the header as optional.

Methods inherited from class org.springframework.restdocs.snippet.AbstractDescriptor

attributes, description, getAttributes, getDescription

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderDescriptor

protected HeaderDescriptor(String name)

Creates a new HeaderDescriptor describing the header with the given name.

Parameters:

name - the name

See Also:

• HttpHeaders

Method Details

optional

public final HeaderDescriptor optional()

Marks the header as optional.

Returns:

this

getName

public final String getName()

Returns the name for the header.

Returns:

the header name

isOptional

public final boolean isOptional()

Returns true if the described header is optional, otherwise false.

Returns:

true if the described header is optional, otherwise false