Class CookieDescriptor

java.lang.Object

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

org.springframework.restdocs.snippet.IgnorableDescriptor<CookieDescriptor>

org.springframework.restdocs.cookies.CookieDescriptor

public class CookieDescriptor
extends IgnorableDescriptor<CookieDescriptor>

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

Since:

3.0

Author:

Clyde Stubbs, Andy Wilkinson

See Also:

• CookieDocumentation.cookieWithName(String)

Constructor Summary

Constructors

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

Method Summary

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

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

ignored, isIgnored

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

CookieDescriptor

protected CookieDescriptor(String name)

Creates a new CookieDescriptor describing the cookie with the given name.

Parameters:

name - the name

Method Details

optional

public final CookieDescriptor optional()

Marks the cookie as optional.

Returns:

this

getName

public final String getName()

Returns the name for the cookie.

Returns:

the cookie name

isOptional

public final boolean isOptional()

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

Returns:

true if the described cookie is optional, otherwise false