retrofit.mime

Class TypedFile

java.lang.Object

retrofit.mime.TypedFile

All Implemented Interfaces:

TypedInput, TypedOutput

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

File and its mime type.

Author:

Bob Lee (bob@squareup.com)

Constructor Summary

Constructors

Constructor and Description
TypedFile(java.lang.String mimeType, java.io.File file) Constructs a new typed file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.io.File	file() Returns the file.
java.lang.String	fileName() Original filename.
int	hashCode()
java.io.InputStream	in() Read bytes as stream.
long	length() Length in bytes.
java.lang.String	mimeType() Returns the mime type.
void	moveTo(TypedFile destination) Atomically moves the contents of this file to a new location.
java.lang.String	toString()
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, wait, wait, wait

Constructor Detail

TypedFile

public TypedFile(java.lang.String mimeType,
                 java.io.File file)

Constructs a new typed file.

Throws:

java.lang.NullPointerException - if file or mimeType is null

Method Detail

file

public java.io.File file()

Returns the file.

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

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

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

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

moveTo

public void moveTo(TypedFile destination)
            throws java.io.IOException

Atomically moves the contents of this file to a new location.

Parameters:

destination - file

Throws:

java.io.IOException - if the move fails

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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