Package org.springframework.restdocs.request

Class RequestPartDescriptor

java.lang.Object

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

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

org.springframework.restdocs.request.RequestPartDescriptor

public class RequestPartDescriptor
extends IgnorableDescriptor<RequestPartDescriptor>

A descriptor of a request part.

Since:

1.1.0

Author:

Andy Wilkinson

See Also:

• RequestDocumentation.partWithName(java.lang.String)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestPartDescriptor(String name)	Creates a new RequestPartDescriptor describing the request part with the given name.

Method Summary

Modifier and Type	Method	Description
final String	getName()	Returns the name of the request part being described by this descriptor.
final boolean	isOptional()	Returns true if the described request part is optional, otherwise false.
final RequestPartDescriptor	optional()	Marks the request part 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

RequestPartDescriptor

protected RequestPartDescriptor(String name)

Creates a new RequestPartDescriptor describing the request part with the given name.

Parameters:

name - the name of the request part

Method Details

optional

public final RequestPartDescriptor optional()

Marks the request part as optional.

Returns:

this

getName

public final String getName()

Returns the name of the request part being described by this descriptor.

Returns:

the name of the parameter

isOptional

public final boolean isOptional()

Returns true if the described request part is optional, otherwise false.

Returns:

true if the described request part is optional, otherwise false