Uses of Class
org.springframework.restdocs.cookies.CookieDescriptor

Packages that use CookieDescriptor

Package	Description
org.springframework.restdocs.cookies	Documenting the cookies of a RESTful API's requests and responses.

Uses of CookieDescriptor in org.springframework.restdocs.cookies

Methods in org.springframework.restdocs.cookies that return CookieDescriptor

Modifier and Type	Method	Description
static CookieDescriptor	CookieDocumentation.cookieWithName(String name)	Creates a CookieDescriptor that describes a cookie with the given name.
final CookieDescriptor	CookieDescriptor.optional()	Marks the cookie as optional.

Methods in org.springframework.restdocs.cookies that return types with arguments of type CookieDescriptor

Modifier and Type	Method	Description
protected final Map<String,CookieDescriptor>	AbstractCookiesSnippet.getCookieDescriptors()	Returns the list of CookieDescriptors that will be used to generate the documentation.

Methods in org.springframework.restdocs.cookies with parameters of type CookieDescriptor

Modifier and Type	Method	Description
final RequestCookiesSnippet	RequestCookiesSnippet.and(CookieDescriptor... additionalDescriptors)	Returns a new RequestCookiesSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseCookiesSnippet	ResponseCookiesSnippet.and(CookieDescriptor... additionalDescriptors)	Returns a new ResponseCookiesSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
protected Map<String,Object>	AbstractCookiesSnippet.createModelForDescriptor(CookieDescriptor descriptor)	Returns a model for the given descriptor.
static RequestCookiesSnippet	CookieDocumentation.relaxedRequestCookies(Map<String,Object> attributes, CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operations's request.
static RequestCookiesSnippet	CookieDocumentation.relaxedRequestCookies(CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operation's request.
static ResponseCookiesSnippet	CookieDocumentation.relaxedResponseCookies(Map<String,Object> attributes, CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operations's response.
static ResponseCookiesSnippet	CookieDocumentation.relaxedResponseCookies(CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operation's response.
static RequestCookiesSnippet	CookieDocumentation.requestCookies(Map<String,Object> attributes, CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operations's request.
static RequestCookiesSnippet	CookieDocumentation.requestCookies(CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operation's request.
static ResponseCookiesSnippet	CookieDocumentation.responseCookies(Map<String,Object> attributes, CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operations's response.
static ResponseCookiesSnippet	CookieDocumentation.responseCookies(CookieDescriptor... descriptors)	Returns a new Snippet that will document the cookies of the API operation's response.

Method parameters in org.springframework.restdocs.cookies with type arguments of type CookieDescriptor

Modifier and Type	Method	Description
final RequestCookiesSnippet	RequestCookiesSnippet.and(List<CookieDescriptor> additionalDescriptors)	Returns a new RequestCookiesSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseCookiesSnippet	ResponseCookiesSnippet.and(List<CookieDescriptor> additionalDescriptors)	Returns a new ResponseCookiesSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static RequestCookiesSnippet	CookieDocumentation.relaxedRequestCookies(List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operation's request.
static RequestCookiesSnippet	CookieDocumentation.relaxedRequestCookies(Map<String,Object> attributes, List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operations's request.
static ResponseCookiesSnippet	CookieDocumentation.relaxedResponseCookies(List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operation's response.
static ResponseCookiesSnippet	CookieDocumentation.relaxedResponseCookies(Map<String,Object> attributes, List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operations's response.
static RequestCookiesSnippet	CookieDocumentation.requestCookies(List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operation's request.
static RequestCookiesSnippet	CookieDocumentation.requestCookies(Map<String,Object> attributes, List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operations's request.
static ResponseCookiesSnippet	CookieDocumentation.responseCookies(List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operation's response.
static ResponseCookiesSnippet	CookieDocumentation.responseCookies(Map<String,Object> attributes, List<CookieDescriptor> descriptors)	Returns a new Snippet that will document the cookies of the API operations's response.

Constructor parameters in org.springframework.restdocs.cookies with type arguments of type CookieDescriptor

Modifier	Constructor	Description
protected	AbstractCookiesSnippet(String type, List<CookieDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedCookies)	Creates a new AbstractCookiesSnippet that will produce a snippet named <type>-cookies.
protected	RequestCookiesSnippet(List<CookieDescriptor> descriptors)	Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
protected	RequestCookiesSnippet(List<CookieDescriptor> descriptors, boolean ignoreUndocumentedCookies)	Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
protected	RequestCookiesSnippet(List<CookieDescriptor> descriptors, Map<String,Object> attributes)	Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
protected	RequestCookiesSnippet(List<CookieDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedCookies)	Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
protected	ResponseCookiesSnippet(List<CookieDescriptor> descriptors)	Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
protected	ResponseCookiesSnippet(List<CookieDescriptor> descriptors, boolean ignoreUndocumentedCookies)	Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
protected	ResponseCookiesSnippet(List<CookieDescriptor> descriptors, Map<String,Object> attributes)	Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
protected	ResponseCookiesSnippet(List<CookieDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedCookies)	Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.