Package org.springframework.restdocs.request

Class ParameterDescriptor

java.lang.Object

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

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

org.springframework.restdocs.request.ParameterDescriptor

public class ParameterDescriptor
extends IgnorableDescriptor<ParameterDescriptor>

A descriptor of a request or path parameter.

Author:

Andy Wilkinson

See Also:

• RequestDocumentation.parameterWithName(java.lang.String)

Constructor Summary

Constructors

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

Method Summary

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

ParameterDescriptor

protected ParameterDescriptor(String name)

Creates a new ParameterDescriptor describing the parameter with the given name.

Parameters:

name - the name of the parameter

Method Details

optional

public final ParameterDescriptor optional()

Marks the parameter as optional.

Returns:

this

getName

public final String getName()

Returns the name of the parameter being described by this descriptor.

Returns:

the name of the parameter

isOptional

public final boolean isOptional()

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

Returns:

true if the described parameter is optional, otherwise false