org.springframework.restdocs.payload

Class SubsectionDescriptor

java.lang.Object

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

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

org.springframework.restdocs.payload.FieldDescriptor

org.springframework.restdocs.payload.SubsectionDescriptor

public class SubsectionDescriptor
extends FieldDescriptor

A description of a subsection, i.e. a field and all of its descendants, in a request or response payload.

Since:

1.2.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubsectionDescriptor(java.lang.String path) Creates a new SubsectionDescriptor describing the subsection with the given path.

Method Summary

Methods inherited from class org.springframework.restdocs.payload.FieldDescriptor

getPath, getType, isOptional, optional, type

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 Detail

SubsectionDescriptor

protected SubsectionDescriptor(java.lang.String path)

Creates a new SubsectionDescriptor describing the subsection with the given path.

Parameters:

path - the path