org.springframework.restdocs.payload

Class FieldDescriptor

java.lang.Object

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

org.springframework.restdocs.payload.FieldDescriptor

public class FieldDescriptor
extends AbstractDescriptor<FieldDescriptor>

A description of a field found in a request or response payload

Author:

Andreas Evers, Andy Wilkinson

See Also:

PayloadDocumentation.fieldWithPath(String)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldDescriptor(String path) Creates a new FieldDescriptor describing the field with the given path.

Method Summary

Modifier and Type	Method and Description
FieldDescriptor	description(String description) Specifies the description of the field
String	getDescription() Returns the description for the field
String	getPath() Returns the path of the field described by this descriptor
Object	getType() Returns the type of the field described by this descriptor
boolean	isOptional() Returns true if the described field is optional, otherwise false
FieldDescriptor	optional() Marks the field as optional
FieldDescriptor	type(Object type) Specifies the type of the field.

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

FieldDescriptor

protected FieldDescriptor(String path)

Creates a new FieldDescriptor describing the field with the given path.

Parameters:

path - the path

Method Detail

type

public final FieldDescriptor type(Object type)

Specifies the type of the field. When documenting a JSON payload, the JsonFieldType enumeration will typically be used.

Parameters:

type - The type of the field

Returns:

this

See Also:

JsonFieldType

optional

public final FieldDescriptor optional()

Marks the field as optional

Returns:

this

description

public final FieldDescriptor description(String description)

Specifies the description of the field

Parameters:

description - The field's description

Returns:

this

getPath

public final String getPath()

Returns the path of the field described by this descriptor

Returns:

the path

getType

public final Object getType()

Returns the type of the field described by this descriptor

Returns:

the type

isOptional

public final boolean isOptional()

Returns true if the described field is optional, otherwise false

Returns:

true if the described field is optional, otherwise false

getDescription

public final String getDescription()

Returns the description for the field

Returns:

the field description