Class FieldPathPayloadSubsectionExtractor

java.lang.Object

org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor

All Implemented Interfaces:

PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

public class FieldPathPayloadSubsectionExtractor
extends Object
implements PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

A PayloadSubsectionExtractor that extracts the subsection of the JSON payload identified by a field path.

Since:

1.2.0

Author:

Andy Wilkinson

See Also:

• PayloadDocumentation.beneathPath(String)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldPathPayloadSubsectionExtractor(String fieldPath)	Creates a new FieldPathPayloadSubsectionExtractor that will extract the subsection of the JSON payload beneath the given fieldPath.
protected	FieldPathPayloadSubsectionExtractor(String fieldPath, String subsectionId)	Creates a new FieldPathPayloadSubsectionExtractor that will extract the subsection of the JSON payload beneath the given fieldPath and that will use the given subsectionId to identify the subsection.

Method Summary

Modifier and Type	Method	Description
byte[]	extractSubsection(byte[] payload, @Nullable org.springframework.http.MediaType contentType)	Extracts a subsection of the given payload that has the given contentType.
byte[]	extractSubsection(byte[] payload, @Nullable org.springframework.http.MediaType contentType, List<FieldDescriptor> descriptors)	Extracts a subsection of the given payload that has the given contentType and that is described by the given descriptors.
protected String	getFieldPath()	Returns the path of the field that will be extracted.
String	getSubsectionId()	Returns an identifier for the subsection that this extractor will extract.
FieldPathPayloadSubsectionExtractor	withSubsectionId(String subsectionId)	Returns an extractor with the given subsectionId.

Methods inherited from class Object

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

Constructor Details

FieldPathPayloadSubsectionExtractor

protected FieldPathPayloadSubsectionExtractor(String fieldPath)

Creates a new FieldPathPayloadSubsectionExtractor that will extract the subsection of the JSON payload beneath the given fieldPath. The fieldPath prefixed with beneath- with be used as the subsection ID.

Parameters:

fieldPath - the path of the field

FieldPathPayloadSubsectionExtractor

protected FieldPathPayloadSubsectionExtractor(String fieldPath,
 String subsectionId)

Creates a new FieldPathPayloadSubsectionExtractor that will extract the subsection of the JSON payload beneath the given fieldPath and that will use the given subsectionId to identify the subsection.

Parameters:

fieldPath - the path of the field

subsectionId - the ID of the subsection

Method Details

extractSubsection

public byte[] extractSubsection(byte[] payload,
 @Nullable org.springframework.http.MediaType contentType)

Description copied from interface: PayloadSubsectionExtractor

Extracts a subsection of the given payload that has the given contentType.

Specified by:

extractSubsection in interface PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

Parameters:

payload - the payload

contentType - the content type of the payload

Returns:

the subsection of the payload

extractSubsection

public byte[] extractSubsection(byte[] payload,
 @Nullable org.springframework.http.MediaType contentType,
 List<FieldDescriptor> descriptors)

Description copied from interface: PayloadSubsectionExtractor

Extracts a subsection of the given payload that has the given contentType and that is described by the given descriptors.

Specified by:

extractSubsection in interface PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

Parameters:

payload - the payload

contentType - the content type of the payload

descriptors - descriptors that describe the payload

Returns:

the subsection of the payload

getSubsectionId

public String getSubsectionId()

Description copied from interface: PayloadSubsectionExtractor

Returns an identifier for the subsection that this extractor will extract.

Specified by:

getSubsectionId in interface PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

Returns:

the identifier

getFieldPath

protected String getFieldPath()

Returns the path of the field that will be extracted.

Returns:

the path of the field

withSubsectionId

public FieldPathPayloadSubsectionExtractor withSubsectionId(String subsectionId)

Description copied from interface: PayloadSubsectionExtractor

Returns an extractor with the given subsectionId.

Specified by:

withSubsectionId in interface PayloadSubsectionExtractor<FieldPathPayloadSubsectionExtractor>

Parameters:

subsectionId - the subsection ID

Returns:

the customized extractor