org.springframework.restdocs.payload

Interface PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>>

Type Parameters:

T - The subsection extractor subclass

All Known Implementing Classes:

FieldPathPayloadSubsectionExtractor

public interface PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>>

Strategy interface for extracting a subsection of a payload.

Since:

1.2.0

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
byte[]	extractSubsection(byte[] payload, org.springframework.http.MediaType contentType) Extracts a subsection of the given payload that has the given contentType.
String	getSubsectionId() Returns an identifier for the subsection that this extractor will extract.
T	withSubsectionId(String subsectionId) Returns an extractor with the given subsectionId.

Method Detail

extractSubsection

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

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

Parameters:

payload - the payload

contentType - the content type of the payload

Returns:

the subsection of the payload

getSubsectionId

String getSubsectionId()

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

Returns:

the identifier

withSubsectionId

T withSubsectionId(String subsectionId)

Returns an extractor with the given subsectionId.

Parameters:

subsectionId - the subsection ID

Returns:

the customized extractor