net.gotev.uploadservice

Class UploadFile

java.lang.Object

net.gotev.uploadservice.UploadFile

All Implemented Interfaces:

Parcelable

public class UploadFile
extends Object
implements Parcelable

Represents a file to upload.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<UploadFile>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
UploadFile(String path) Creates a new UploadFile.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
String	getContentType(Context context) Returns the content type for the file
String	getName(Context context) Returns the name of this file.
String	getPath() Returns the string this was initialized with, either an absolute file path or Android content URI
String	getProperty(String key) Gets a property associated to this file.
String	getProperty(String key, String defaultValue) Gets a property associated to this file.
InputStream	getStream(Context context) Gets the InputStream to read the content of this file.
long	length(Context context) Gets the file length in bytes.
void	setProperty(String key, String value) Sets a property for this file.
void	writeToParcel(Parcel parcel, int arg1)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<UploadFile> CREATOR

Constructor Detail

UploadFile

public UploadFile(String path)
           throws FileNotFoundException

Creates a new UploadFile.

Parameters:

path - absolute path to a file or an Android content Uri string

Throws:

FileNotFoundException - if the file can't be found at the specified path

IllegalArgumentException - if you passed invalid argument values

Method Detail

length

public long length(Context context)

Gets the file length in bytes.

Returns:

file length

getStream

public final InputStream getStream(Context context)
                            throws FileNotFoundException

Gets the InputStream to read the content of this file.

Returns:

file input stream

Throws:

FileNotFoundException - if the file can't be found at the path specified in the constructor

getContentType

public final String getContentType(Context context)

Returns the content type for the file

Returns:

content type

getName

public final String getName(Context context)

Returns the name of this file.

Returns:

string

getPath

public final String getPath()

Returns the string this was initialized with, either an absolute file path or Android content URI

Returns:

String

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel parcel,
                          int arg1)

Specified by:

writeToParcel in interface Parcelable

setProperty

public void setProperty(String key,
                        String value)

Sets a property for this file. If you want to store objects, serialize them in JSON strings.

Parameters:

key - property key

value - property value

getProperty

public String getProperty(String key)

Gets a property associated to this file.

Parameters:

key - property key

Returns:

property value or null if the value does not exist.

getProperty

public String getProperty(String key,
                          String defaultValue)

Gets a property associated to this file.

Parameters:

key - property key

defaultValue - default value to use if the key does not exist or the value is null

Returns:

property value or the default value passed