Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

DropBoxManager.Entry

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

java.lang.Object
   ↳ android.os.DropBoxManager.Entry


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

Fields

public static final Creator<DropBoxManager.Entry> CREATOR

Public constructors

DropBoxManager.Entry(String tag, long millis)

Create a new empty Entry with no contents.

DropBoxManager.Entry(String tag, long millis, String text)

Create a new Entry with plain text contents.

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

Create a new Entry with byte array contents.

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

Create a new Entry with streaming data contents.

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

Create a new Entry with the contents read from a file.

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()
void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 8
public static final Creator<DropBoxManager.Entry> CREATOR

Public constructors

DropBoxManager.Entry

added in API level 8
public DropBoxManager.Entry (String tag, 
                long millis)

Create a new empty Entry with no contents.

Parameters
tag String

millis long

DropBoxManager.Entry

added in API level 8
public DropBoxManager.Entry (String tag, 
                long millis, 
                String text)

Create a new Entry with plain text contents.

Parameters
tag String

millis long

text String

DropBoxManager.Entry

added in API level 8
public DropBoxManager.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

millis long

data byte

flags int

DropBoxManager.Entry

added in API level 8
public DropBoxManager.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

millis long

data ParcelFileDescriptor

flags int

DropBoxManager.Entry

added in API level 8
public DropBoxManager.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

millis long

data File

flags int

Throws
IOException

Public methods

close

added in API level 8
public void close ()

Close the input stream associated with this entry.

describeContents

added in API level 8
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.

getFlags

added in API level 8
public int getFlags ()

Returns
int flags describing the content returned by getInputStream().

getInputStream

added in API level 8
public InputStream getInputStream ()

Returns
InputStream the uncompressed contents of the entry, or null if the contents were lost

Throws
IOException

getTag

added in API level 8
public String getTag ()

Returns
String the tag originally attached to the entry.

getText

added in API level 8
public String getText (int maxBytes)

Parameters
maxBytes int: of string to return (will truncate at this length).

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

getTimeMillis

added in API level 8
public long getTimeMillis ()

Returns
long time when the entry was originally created.

writeToParcel

added in API level 8
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.