retrofit.mime

Class TypedByteArray

java.lang.Object

retrofit.mime.TypedByteArray

All Implemented Interfaces:

TypedInput, TypedOutput

Direct Known Subclasses:

TypedString

public class TypedByteArray
extends java.lang.Object
implements TypedInput, TypedOutput

Byte array and its mime type.

Author:

Bob Lee (bob@squareup.com)

Constructor Summary

Constructors

Constructor and Description
TypedByteArray(java.lang.String mimeType, byte[] bytes) Constructs a new typed byte array.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	fileName() Original filename.
byte[]	getBytes()
int	hashCode()
java.io.InputStream	in() Read bytes as stream.
long	length() Length in bytes.
java.lang.String	mimeType() Returns the mime type.
void	writeTo(java.io.OutputStream out) Writes these bytes to the given output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedByteArray

public TypedByteArray(java.lang.String mimeType,
                      byte[] bytes)

Constructs a new typed byte array. Sets mimeType to application/unknown if absent.

Throws:

java.lang.NullPointerException - if bytes are null

Method Detail

getBytes

public byte[] getBytes()

fileName

public java.lang.String fileName()

Description copied from interface: TypedOutput

Original filename. Used only for multipart requests, may be null.

Specified by:

fileName in interface TypedOutput

mimeType

public java.lang.String mimeType()

Description copied from interface: TypedInput

Returns the mime type.

Specified by:

mimeType in interface TypedInput

Specified by:

mimeType in interface TypedOutput

length

public long length()

Description copied from interface: TypedInput

Length in bytes. Returns -1 if length is unknown.

Specified by:

length in interface TypedInput

Specified by:

length in interface TypedOutput

writeTo

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

Description copied from interface: TypedOutput

Writes these bytes to the given output stream.

Specified by:

writeTo in interface TypedOutput

Throws:

java.io.IOException

in

public java.io.InputStream in()
                       throws java.io.IOException

Description copied from interface: TypedInput

Read bytes as stream. Unless otherwise specified, this method may only be called once. It is the responsibility of the caller to close the stream.

Specified by:

in in interface TypedInput

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object