| java.lang.Object | |
| ↳ | android.os.ParcelFileDescriptor |
The FileDescriptor returned by readFileDescriptor(), allowing
you to close it when done with it.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ParcelFileDescriptor.AutoCloseInputStream | An InputStream you can create on a ParcelFileDescriptor, which will
take care of calling ParcelFileDescriptor.close() for you when the stream is closed. |
||||||||||
| ParcelFileDescriptor.AutoCloseOutputStream | An OutputStream you can create on a ParcelFileDescriptor, which will
take care of calling ParcelFileDescriptor.close() for you when the stream is closed. |
||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | MODE_APPEND | For use with open(File, int): append to end of file while writing. |
|||||||||
| int | MODE_CREATE | For use with open(File, int): create the file if it doesn't already exist. |
|||||||||
| int | MODE_READ_ONLY | For use with open(File, int): open the file with read-only access. |
|||||||||
| int | MODE_READ_WRITE | For use with open(File, int): open the file with read and write access. |
|||||||||
| int | MODE_TRUNCATE | For use with open(File, int): erase contents of file when opening. |
|||||||||
| int | MODE_WORLD_READABLE | For use with open(File, int): if MODE_CREATE has been supplied
and this file doesn't already exist, then create the file with
permissions such that any application can read it. |
|||||||||
| int | MODE_WORLD_WRITEABLE | For use with open(File, int): if MODE_CREATE has been supplied
and this file doesn't already exist, then create the file with
permissions such that any application can write it. |
|||||||||
| int | MODE_WRITE_ONLY | For use with open(File, int): open the file with write-only access. |
|||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CREATOR | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Take ownership of a raw native fd in to a new ParcelFileDescriptor.
| |||||||||||
Close the ParcelFileDescriptor.
| |||||||||||
Create two ParcelFileDescriptors structured as a data pipe.
| |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Return the native fd int for this ParcelFileDescriptor and detach it
from the object here.
| |||||||||||
Create a new ParcelFileDescriptor that is a dup of an existing
FileDescriptor.
| |||||||||||
Create a new ParcelFileDescriptor from a raw native fd.
| |||||||||||
Create a new ParcelFileDescriptor from the specified Socket.
| |||||||||||
Return the native fd int for this ParcelFileDescriptor.
| |||||||||||
Retrieve the actual FileDescriptor associated with this object.
| |||||||||||
Return the total size of the file representing this fd, as determined
by stat().
| |||||||||||
Create a new ParcelFileDescriptor accessing a given file.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Flatten this object in to a Parcel.
If
PARCELABLE_WRITE_RETURN_VALUE is set in flags,
the file descriptor will be closed after a copy is written to the Parcel. | |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Called before the object's memory is reclaimed by the VM.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
| |||||||||||
For use with open(File, int): append to end of file while writing.
For use with open(File, int): create the file if it doesn't already exist.
For use with open(File, int): open the file with read-only access.
For use with open(File, int): open the file with read and write access.
For use with open(File, int): erase contents of file when opening.
For use with open(File, int): if MODE_CREATE has been supplied
and this file doesn't already exist, then create the file with
permissions such that any application can read it.
For use with open(File, int): if MODE_CREATE has been supplied
and this file doesn't already exist, then create the file with
permissions such that any application can write it.
For use with open(File, int): open the file with write-only access.
Take ownership of a raw native fd in to a new ParcelFileDescriptor. The returned ParcelFileDescriptor now owns the given fd, and will be responsible for closing it. You must not close the fd yourself.
| fd | The native fd that the ParcelFileDescriptor should adopt. |
|---|
Close the ParcelFileDescriptor. This implementation closes the underlying OS resources allocated to represent this stream.
| IOException | If an error occurs attempting to close this ParcelFileDescriptor. |
|---|
Create two ParcelFileDescriptors structured as a data pipe. The first ParcelFileDescriptor in the returned array is the read side; the second is the write side.
| IOException |
|---|
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Return the native fd int for this ParcelFileDescriptor and detach it from the object here. You are now responsible for closing the fd in native code.
Create a new ParcelFileDescriptor that is a dup of an existing FileDescriptor. This obeys standard POSIX semantics, where the new file descriptor shared state such as file position with the original file descriptor.
| IOException |
|---|
Create a new ParcelFileDescriptor from a raw native fd. The new ParcelFileDescriptor holds a dup of the original fd passed in here, so you must still close that fd as well as the new ParcelFileDescriptor.
| fd | The native fd that the ParcelFileDescriptor should dup. |
|---|
| IOException |
|---|
Create a new ParcelFileDescriptor from the specified Socket. The new ParcelFileDescriptor holds a dup of the original FileDescriptor in the Socket, so you must still close the Socket as well as the new ParcelFileDescriptor.
| socket | The Socket whose FileDescriptor is used to create a new ParcelFileDescriptor. |
|---|
Return the native fd int for this ParcelFileDescriptor. The ParcelFileDescriptor still owns the fd, and it still must be closed through this API.
Retrieve the actual FileDescriptor associated with this object.
Return the total size of the file representing this fd, as determined by stat(). Returns -1 if the fd is not a file.
Create a new ParcelFileDescriptor accessing a given file.
| file | The file to be opened. |
|---|---|
| mode | The desired access mode, must be one of
MODE_READ_ONLY, MODE_WRITE_ONLY, or
MODE_READ_WRITE; may also be any combination of
MODE_CREATE, MODE_TRUNCATE,
MODE_WORLD_READABLE, and MODE_WORLD_WRITEABLE. |
| FileNotFoundException | Throws FileNotFoundException if the given file does not exist or can not be opened with the requested mode. |
|---|
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString method
if you intend implementing your own toString method.
Flatten this object in to a Parcel.
If PARCELABLE_WRITE_RETURN_VALUE is set in flags,
the file descriptor will be closed after a copy is written to the Parcel.
| out | The Parcel in which the object should be written. |
|---|---|
| flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|
Called before the object's memory is reclaimed by the VM. This can only happen once the garbage collector has detected that the object is no longer reachable by any thread of the running application.
The method can be used to free system resources or perform other cleanup
before the object is garbage collected. The default implementation of the
method is empty, which is also expected by the VM, but subclasses can
override finalize() as required. Uncaught exceptions which are
thrown during the execution of this method cause it to terminate
immediately but are otherwise ignored.
Note that the VM does guarantee that finalize() is called at most
once for any object, but it doesn't guarantee when (if at all) finalize() will be called. For example, object B's finalize()
can delay the execution of object A's finalize() method and
therefore it can delay the reclamation of A's memory. To be safe, use a
ReferenceQueue, because it provides more control
over the way the VM deals with references during garbage collection.
| Throwable |
|---|