Package org.apache.http.entity.mime.content

Class ByteArrayBody

java.lang.Object

org.apache.http.entity.mime.content.AbstractContentBody

org.apache.http.entity.mime.content.ByteArrayBody

All Implemented Interfaces:

ContentBody, ContentDescriptor

public class ByteArrayBody
extends AbstractContentBody

Binary body part backed by a byte array.

Since:

4.1

See Also:

MultipartEntityBuilder

Constructor Summary

Constructors

Constructor	Description
ByteArrayBody(byte[] data, java.lang.String filename)	Creates a new ByteArrayBody.
ByteArrayBody(byte[] data, java.lang.String mimeType, java.lang.String filename)	Deprecated. (4.3) use ByteArrayBody(byte[], ContentType, String) or MultipartEntityBuilder
ByteArrayBody(byte[] data, ContentType contentType, java.lang.String filename)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCharset()	The body descriptors character set, defaulted appropriately for the MIME type.
long	getContentLength()	Returns the body descriptors content-length.
java.lang.String	getFilename()
java.lang.String	getTransferEncoding()	Returns the body descriptors transfer encoding.
void	writeTo(java.io.OutputStream out)

Methods inherited from class org.apache.http.entity.mime.content.AbstractContentBody

getContentType, getMediaType, getMimeType, getSubType

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayBody

@Deprecated
public ByteArrayBody(byte[] data,
                     java.lang.String mimeType,
                     java.lang.String filename)

Deprecated.

(4.3) use ByteArrayBody(byte[], ContentType, String) or MultipartEntityBuilder

Creates a new ByteArrayBody.

Parameters:

data - The contents of the file contained in this part.

mimeType - The MIME type of the file contained in this part.

filename - The name of the file contained in this part.

ByteArrayBody

public ByteArrayBody(byte[] data,
                     ContentType contentType,
                     java.lang.String filename)

Since:

4.3

ByteArrayBody

public ByteArrayBody(byte[] data,
                     java.lang.String filename)

Creates a new ByteArrayBody.

Parameters:

data - The contents of the file contained in this part.

filename - The name of the file contained in this part.

Method Detail

getFilename

public java.lang.String getFilename()

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Throws:

java.io.IOException

getCharset

public java.lang.String getCharset()

Description copied from interface: ContentDescriptor

The body descriptors character set, defaulted appropriately for the MIME type.

For TEXT types, this will be defaulted to us-ascii. For other types, when the charset parameter is missing this property will be null.

Specified by:

getCharset in interface ContentDescriptor

Overrides:

getCharset in class AbstractContentBody

Returns:

Character set, which has been parsed from the content-type definition. Not null for TEXT types, when unset will be set to default us-ascii. For other types, when unset, null will be returned.

getTransferEncoding

public java.lang.String getTransferEncoding()

Description copied from interface: ContentDescriptor

Returns the body descriptors transfer encoding.

Returns:

The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.

getContentLength

public long getContentLength()

Description copied from interface: ContentDescriptor

Returns the body descriptors content-length.

Returns:

Content length, if known, or -1, to indicate the absence of a content-length header.