DropBoxManager.Entry | API reference

DropBoxManager.Entry | API reference | Android Developers

public static class DropBoxManager.Entry
extends Object implements Closeable, Parcelable

A single entry retrieved from the drop box. This may include a reference to a stream, so you must call close() when you are done using it.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<DropBoxManager.Entry>`	`CREATOR`

Public constructors
`Entry(String tag, long millis)` Create a new empty Entry with no contents.
`Entry(String tag, long millis, ParcelFileDescriptor data, int flags)` Create a new Entry with streaming data contents.
`Entry(String tag, long millis, byte[] data, int flags)` Create a new Entry with byte array contents.
`Entry(String tag, long millis, File data, int flags)` Create a new Entry with the contents read from a file.
`Entry(String tag, long millis, String text)` Create a new Entry with plain text contents.

Public methods
`void`	`close()` Close the input stream associated with this entry.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getFlags()`
`InputStream`	`getInputStream()`
`String`	`getTag()`
`String`	`getText(int maxBytes)`
`long`	`getTimeMillis()` Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

From interface java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Fields

Public constructors

Entry

public Entry (String tag, 
                long millis)

Create a new empty Entry with no contents.

Parameters
`tag`	`String`: This value cannot be `null`.
`millis`	`long`: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Entry

public Entry (String tag, 
                long millis, 
                ParcelFileDescriptor data, 
                int flags)

Create a new Entry with streaming data contents. Takes ownership of the ParcelFileDescriptor.

Parameters
`tag`	`String`: This value cannot be `null`.
`millis`	`long`: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
`data`	`ParcelFileDescriptor`: This value may be `null`.
`flags`	`int`: Value is either `0` or a combination of the following: `DropBoxManager.IS_EMPTY` `DropBoxManager.IS_TEXT` `DropBoxManager.IS_GZIPPED`

Entry

public Entry (String tag, 
                long millis, 
                byte[] data, 
                int flags)

Create a new Entry with byte array contents. The data array must not be modified after creating this entry.

Parameters
`tag`	`String`: This value cannot be `null`.
`millis`	`long`: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
`data`	`byte`: This value may be `null`.
`flags`	`int`: Value is either `0` or a combination of the following: `DropBoxManager.IS_EMPTY` `DropBoxManager.IS_TEXT` `DropBoxManager.IS_GZIPPED`

Entry

public Entry (String tag, 
                long millis, 
                File data, 
                int flags)

Create a new Entry with the contents read from a file. The file will be read when the entry's contents are requested.

Parameters
`tag`	`String`: This value cannot be `null`.
`millis`	`long`: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
`data`	`File`: This value cannot be `null`.
`flags`	`int`: Value is either `0` or a combination of the following: `DropBoxManager.IS_EMPTY` `DropBoxManager.IS_TEXT` `DropBoxManager.IS_GZIPPED`

Throws
`IOException`

Entry

public Entry (String tag, 
                long millis, 
                String text)

Create a new Entry with plain text contents.

Parameters
`tag`	`String`: This value cannot be `null`.
`millis`	`long`: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
`text`	`String`: This value cannot be `null`.

Public methods

close

public void close ()

Close the input stream associated with this entry.

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getTag

public String getTag ()

Returns
`String`	the tag originally attached to the entry. This value cannot be `null`.

getText

public String getText (int maxBytes)

Parameters
`maxBytes`	`int`: of string to return (will truncate at this length). Value is a non-negative number of bytes.

Returns
`String`	the uncompressed text contents of the entry, null if the entry is not text.

getTimeMillis

public long getTimeMillis ()

Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
`long`	time when the entry was originally created. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.