public class MultipartContent extends AbstractHttpContentSerializes MIME multipart content as specified by RFC 2387: The MIME Multipart/Related Content-type and RFC 2046: Multipurpose Internet Mail Extensions: The Multipart/mixed (primary) subtype.
By default the media type is "multipart/related; boundary=END_OF_PART, but this may be customized by calling #setMediaType(HttpMediaType), #getMediaType(), or #setBoundary(String).
Implementation is not thread-safe.
Constructors
MultipartContent()
public MultipartContent()MultipartContent(String boundary)
public MultipartContent(String boundary)| Parameter | |
|---|---|
| Name | Description |
boundary |
String |
Methods
addPart(MultipartContent.Part part)
public MultipartContent addPart(MultipartContent.Part part)Adds an HTTP multipart part.
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
| Parameter | |
|---|---|
| Name | Description |
part |
MultipartContent.Part |
| Returns | |
|---|---|
| Type | Description |
MultipartContent |
|
getBoundary()
public final String getBoundary()Returns the boundary string to use.
| Returns | |
|---|---|
| Type | Description |
String |
|
getParts()
public final Collection<MultipartContent.Part> getParts()Returns an unmodifiable view of the parts of the HTTP multipart request.
| Returns | |
|---|---|
| Type | Description |
Collection<Part> |
|
retrySupported()
public boolean retrySupported()Default implementation returns true, but subclasses may override.
| Returns | |
|---|---|
| Type | Description |
boolean |
|
setBoundary(String boundary)
public MultipartContent setBoundary(String boundary)Sets the boundary string to use.
Defaults to "END_OF_PART".
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
| Parameter | |
|---|---|
| Name | Description |
boundary |
String |
| Returns | |
|---|---|
| Type | Description |
MultipartContent |
|
setContentParts(Collection<? extends HttpContent> contentParts)
public MultipartContent setContentParts(Collection<? extends HttpContent> contentParts)Sets the HTTP content parts of the HTTP multipart request, where each part is assumed to have no HTTP headers and no encoding.
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
| Parameter | |
|---|---|
| Name | Description |
contentParts |
Collection<? extends com.google.api.client.http.HttpContent> |
| Returns | |
|---|---|
| Type | Description |
MultipartContent |
|
setMediaType(HttpMediaType mediaType)
public MultipartContent setMediaType(HttpMediaType mediaType)Sets the media type to use for the Content-Type header, or null if unspecified.
This will also overwrite any previously set parameter of the media type (for example
"charset"), and therefore might change other properties as well.
| Parameter | |
|---|---|
| Name | Description |
mediaType |
HttpMediaType |
| Returns | |
|---|---|
| Type | Description |
MultipartContent |
|
setParts(Collection<MultipartContent.Part> parts)
public MultipartContent setParts(Collection<MultipartContent.Part> parts)Sets the parts of the HTTP multipart request.
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
| Parameter | |
|---|---|
| Name | Description |
parts |
Collection<Part> |
| Returns | |
|---|---|
| Type | Description |
MultipartContent |
|
writeTo(OutputStream out)
public void writeTo(OutputStream out)| Parameter | |
|---|---|
| Name | Description |
out |
OutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|