org.springframework.restdocs.operation

Interface OperationRequestPart

public interface OperationRequestPart

A part of a multipart request.

Author:

Andy Wilkinson

See Also:

OperationRequest.getParts()

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Returns the contents of the part.
String	getContentAsString() Returns the content of the part as a String.
org.springframework.http.HttpHeaders	getHeaders() Returns the part's headers.
String	getName() Returns the name of the part.
String	getSubmittedFileName() Returns the name of the file that is being uploaded in this part.

Method Detail

getName

String getName()

Returns the name of the part.

Returns:

the name

getSubmittedFileName

String getSubmittedFileName()

Returns the name of the file that is being uploaded in this part.

Returns:

the name of the file

getContent

byte[] getContent()

Returns the contents of the part.

Returns:

the contents

getContentAsString

String getContentAsString()

Returns the content of the part as a String. If the part has no content an empty string is returned. If the part has a Content-Type header that specifies a charset then that charset will be used when converting the contents to a String.

Returns:

the contents as string, never null

getHeaders

org.springframework.http.HttpHeaders getHeaders()

Returns the part's headers.

Returns:

the headers