org.springframework.restdocs.request

Class ParameterDescriptor

java.lang.Object

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

org.springframework.restdocs.request.ParameterDescriptor

public class ParameterDescriptor
extends AbstractDescriptor<ParameterDescriptor>

A descriptor of a request or path parameter

Author:

Andy Wilkinson

See Also:

RequestDocumentation.parameterWithName(java.lang.String)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ParameterDescriptor	description(String description) Specifies the description of the parameter
String	getDescription() Returns the description of the parameter
String	getName() Returns the name of the parameter being described by this descriptor

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

attributes, getAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDescriptor

protected ParameterDescriptor(String name)

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

Parameters:

name - the name of the parameter

Method Detail

description

public final ParameterDescriptor description(String description)

Specifies the description of the parameter

Parameters:

description - The parameter's description

Returns:

this

getName

public final String getName()

Returns the name of the parameter being described by this descriptor

Returns:

the name of the parameter

getDescription

public final String getDescription()

Returns the description of the parameter

Returns:

the description