ParcelFileDescriptor (moe.ios.core API)

java.lang.Object
- android.os.ParcelFileDescriptor

All Implemented Interfaces:

Parcelable, Closeable, AutoCloseable
```
public class ParcelFileDescriptor
extends Object
implements Parcelable, Closeable
```
The FileDescriptor returned by Parcel.readFileDescriptor(), allowing you to close it when done with it.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`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.
`static class`	`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.
`static class`	`ParcelFileDescriptor.FileDescriptorDetachedException` Exception that indicates that the file descriptor was detached.
`static interface`	`ParcelFileDescriptor.OnCloseListener` Callback indicating that a ParcelFileDescriptor has been closed.

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<ParcelFileDescriptor>`	`CREATOR`
`static int`	`MODE_APPEND` For use with `open(java.io.File, int)`: append to end of file while writing.
`static int`	`MODE_CREATE` For use with `open(java.io.File, int)`: create the file if it doesn't already exist.
`static int`	`MODE_READ_ONLY` For use with `open(java.io.File, int)`: open the file with read-only access.
`static int`	`MODE_READ_WRITE` For use with `open(java.io.File, int)`: open the file with read and write access.
`static int`	`MODE_TRUNCATE` For use with `open(java.io.File, int)`: erase contents of file when opening.
`static int`	`MODE_WORLD_READABLE` Deprecated. Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as `ContentProvider`, `BroadcastReceiver`, and `android.app.Service`. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
`static int`	`MODE_WORLD_WRITEABLE` Deprecated. Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as `ContentProvider`, `BroadcastReceiver`, and `android.app.Service`. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
`static int`	`MODE_WRITE_ONLY` For use with `open(java.io.File, int)`: open the file with write-only access.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Constructor and Description
`ParcelFileDescriptor(FileDescriptor fd)`
`ParcelFileDescriptor(FileDescriptor fd, FileDescriptor commChannel)`
`ParcelFileDescriptor(ParcelFileDescriptor wrapped)` Create a new ParcelFileDescriptor wrapped around another descriptor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ParcelFileDescriptor`	`adoptFd(int fd)` Take ownership of a raw native fd in to a new ParcelFileDescriptor.
`boolean`	`canDetectErrors()` Indicates if this ParcelFileDescriptor can communicate and detect remote errors/crashes.
`void`	`checkError()` Detect and throw if the other end of a pipe or socket pair encountered an error or crashed.
`void`	`close()` Close the ParcelFileDescriptor.
`void`	`closeWithError(String msg)` Close the ParcelFileDescriptor, informing any peer that an error occurred while processing.
`static ParcelFileDescriptor[]`	`createPipe()` Create two ParcelFileDescriptors structured as a data pipe.
`static ParcelFileDescriptor[]`	`createReliablePipe()` Create two ParcelFileDescriptors structured as a data pipe.
`static ParcelFileDescriptor[]`	`createReliableSocketPair()` Create two ParcelFileDescriptors structured as a pair of sockets connected to each other.
`static ParcelFileDescriptor[]`	`createReliableSocketPair(int type)`
`static ParcelFileDescriptor[]`	`createSocketPair()` Create two ParcelFileDescriptors structured as a pair of sockets connected to each other.
`static ParcelFileDescriptor[]`	`createSocketPair(int type)`
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable's marshalled representation.
`int`	`detachFd()` Return the native fd int for this ParcelFileDescriptor and detach it from the object here.
`ParcelFileDescriptor`	`dup()` Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor.
`static ParcelFileDescriptor`	`dup(FileDescriptor orig)` Create a new ParcelFileDescriptor that is a dup of an existing FileDescriptor.
`protected void`	`finalize()` Invoked when the garbage collector has detected that this instance is no longer reachable.
`static ParcelFileDescriptor`	`fromData(byte[] data, String name)` Deprecated.
`static ParcelFileDescriptor`	`fromDatagramSocket(DatagramSocket datagramSocket)` Create a new ParcelFileDescriptor from the specified DatagramSocket.
`static ParcelFileDescriptor`	`fromFd(int fd)` Create a new ParcelFileDescriptor from a raw native fd.
`static ParcelFileDescriptor`	`fromSocket(Socket socket)` Create a new ParcelFileDescriptor from the specified Socket.
`int`	`getFd()` Return the native fd int for this ParcelFileDescriptor.
`FileDescriptor`	`getFileDescriptor()` Retrieve the actual FileDescriptor associated with this object.
`long`	`getStatSize()` Return the total size of the file representing this fd, as determined by `stat()`.
`static ParcelFileDescriptor`	`open(File file, int mode)` Create a new ParcelFileDescriptor accessing a given file.
`static int`	`parseMode(String mode)` Converts a string representing a file mode, such as "rw", into a bitmask suitable for use with `open(java.io.File, int)`.
`void`	`releaseResources()` Called when the fd is being closed, for subclasses to release any other resources associated with it, such as acquired providers.
`long`	`seekTo(long pos)` This is needed for implementing AssetFileDescriptor.AutoCloseOutputStream, and I really don't think we want it to be public.
`String`	`toString()` Returns a string containing a concise, human-readable description of this object.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MODE_WORLD_READABLE
```
@Deprecated
public static final int MODE_WORLD_READABLE
```
    Deprecated. Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and android.app.Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
    
    For use with open(java.io.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.
    
    See Also:
    
    Constant Field Values
  - MODE_WORLD_WRITEABLE
```
@Deprecated
public static final int MODE_WORLD_WRITEABLE
```
    Deprecated. Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and android.app.Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
    
    For use with open(java.io.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.
    
    See Also:
    
    Constant Field Values
  - MODE_READ_ONLY
```
public static final int MODE_READ_ONLY
```
    For use with open(java.io.File, int): open the file with read-only access.
    
    See Also:
    
    Constant Field Values
  - MODE_WRITE_ONLY
```
public static final int MODE_WRITE_ONLY
```
    For use with open(java.io.File, int): open the file with write-only access.
    
    See Also:
    
    Constant Field Values
  - MODE_READ_WRITE
```
public static final int MODE_READ_WRITE
```
    For use with open(java.io.File, int): open the file with read and write access.
    
    See Also:
    
    Constant Field Values
  - MODE_CREATE
```
public static final int MODE_CREATE
```
    For use with open(java.io.File, int): create the file if it doesn't already exist.
    
    See Also:
    
    Constant Field Values
  - MODE_TRUNCATE
```
public static final int MODE_TRUNCATE
```
    For use with open(java.io.File, int): erase contents of file when opening.
    
    See Also:
    
    Constant Field Values
  - MODE_APPEND
```
public static final int MODE_APPEND
```
    For use with open(java.io.File, int): append to end of file while writing.
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<ParcelFileDescriptor> CREATOR
```
- Constructor Detail
  - ParcelFileDescriptor
```
public ParcelFileDescriptor(ParcelFileDescriptor wrapped)
```
    Create a new ParcelFileDescriptor wrapped around another descriptor. By default all method calls are delegated to the wrapped descriptor.
  - ParcelFileDescriptor
```
public ParcelFileDescriptor(FileDescriptor fd)
```
  - ParcelFileDescriptor
```
public ParcelFileDescriptor(FileDescriptor fd,
                            FileDescriptor commChannel)
```
- Method Detail
  - open
```
public static ParcelFileDescriptor open(File file,
                                        int mode)
                                 throws FileNotFoundException
```
    Create a new ParcelFileDescriptor accessing a given file.
    
    Parameters:
    
    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.
    
    Returns:
    
    a new ParcelFileDescriptor pointing to the given file.
    
    Throws:
    
    FileNotFoundException - if the given file does not exist or can not be opened with the requested mode.
    
    See Also:
    
    parseMode(String)
  - dup
```
public static ParcelFileDescriptor dup(FileDescriptor orig)
                                throws IOException
```
    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.
    
    Throws:
    
    IOException
  - dup
```
public ParcelFileDescriptor dup()
                         throws IOException
```
    Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor. This obeys standard POSIX semantics, where the new file descriptor shared state such as file position with the original file descriptor.
    
    Throws:
    
    IOException
  - fromFd
```
public static ParcelFileDescriptor fromFd(int fd)
                                   throws 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.
    
    Parameters:
    
    fd - The native fd that the ParcelFileDescriptor should dup.
    
    Returns:
    
    Returns a new ParcelFileDescriptor holding a FileDescriptor for a dup of the given fd.
    
    Throws:
    
    IOException
  - adoptFd
```
public static ParcelFileDescriptor adoptFd(int fd)
```
    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.
    
    Parameters:
    
    fd - The native fd that the ParcelFileDescriptor should adopt.
    
    Returns:
    
    Returns a new ParcelFileDescriptor holding a FileDescriptor for the given fd.
  - fromSocket
```
public static ParcelFileDescriptor fromSocket(Socket socket)
```
    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.
    
    Parameters:
    
    socket - The Socket whose FileDescriptor is used to create a new ParcelFileDescriptor.
    
    Returns:
    
    A new ParcelFileDescriptor with the FileDescriptor of the specified Socket.
  - fromDatagramSocket
```
public static ParcelFileDescriptor fromDatagramSocket(DatagramSocket datagramSocket)
```
    Create a new ParcelFileDescriptor from the specified DatagramSocket.
    
    Parameters:
    
    datagramSocket - The DatagramSocket whose FileDescriptor is used to create a new ParcelFileDescriptor.
    
    Returns:
    
    A new ParcelFileDescriptor with the FileDescriptor of the specified DatagramSocket.
  - createPipe
```
public static ParcelFileDescriptor[] createPipe()
                                         throws IOException
```
    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.
    
    Throws:
    
    IOException
  - createReliablePipe
```
public static ParcelFileDescriptor[] createReliablePipe()
                                                 throws IOException
```
    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.
    The write end has the ability to deliver an error message through closeWithError(String) which can be handled by the read end calling checkError(), usually after detecting an EOF. This can also be used to detect remote crashes.
    
    Throws:
    
    IOException
  - createSocketPair
```
public static ParcelFileDescriptor[] createSocketPair()
                                               throws IOException
```
    Create two ParcelFileDescriptors structured as a pair of sockets connected to each other. The two sockets are indistinguishable.
    
    Throws:
    
    IOException
  - createSocketPair
```
public static ParcelFileDescriptor[] createSocketPair(int type)
                                               throws IOException
```
    Throws:
    
    IOException
  - createReliableSocketPair
```
public static ParcelFileDescriptor[] createReliableSocketPair()
                                                       throws IOException
```
    Create two ParcelFileDescriptors structured as a pair of sockets connected to each other. The two sockets are indistinguishable.
    Both ends have the ability to deliver an error message through closeWithError(String) which can be detected by the other end calling checkError(), usually after detecting an EOF. This can also be used to detect remote crashes.
    
    Throws:
    
    IOException
  - createReliableSocketPair
```
public static ParcelFileDescriptor[] createReliableSocketPair(int type)
                                                       throws IOException
```
    Throws:
    
    IOException
  - fromData
```
@Deprecated
public static ParcelFileDescriptor fromData(byte[] data,
                                                        String name)
                                                 throws IOException
```
    Deprecated.
    
    Parameters:
    
    data - Data to copy.
    
    name - Name for the shared memory area that may back the file descriptor. This is purely informative and may be null.
    
    Returns:
    
    A ParcelFileDescriptor.
    
    Throws:
    
    IOException - if there is an error while creating the shared memory area.
  - parseMode
```
public static int parseMode(String mode)
```
    Converts a string representing a file mode, such as "rw", into a bitmask suitable for use with open(java.io.File, int).
    
    Parameters:
    
    mode - The string representation of the file mode.
    
    Returns:
    
    A bitmask representing the given file mode.
    
    Throws:
    
    IllegalArgumentException - if the given string does not match a known file mode.
  - getFileDescriptor
```
public FileDescriptor getFileDescriptor()
```
    Retrieve the actual FileDescriptor associated with this object.
    
    Returns:
    
    Returns the FileDescriptor associated with this object.
  - getStatSize
```
public long getStatSize()
```
    Return the total size of the file representing this fd, as determined by stat(). Returns -1 if the fd is not a file.
  - seekTo
```
public long seekTo(long pos)
            throws IOException
```
    This is needed for implementing AssetFileDescriptor.AutoCloseOutputStream, and I really don't think we want it to be public.
    
    Throws:
    
    IOException
  - getFd
```
public int getFd()
```
    Return the native fd int for this ParcelFileDescriptor. The ParcelFileDescriptor still owns the fd, and it still must be closed through this API.
  - detachFd
```
public int detachFd()
```
    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.
    You should not detach when the original creator of the descriptor is expecting a reliable signal through close() or closeWithError(String).
    
    See Also:
    
    canDetectErrors()
  - close
```
public void close()
           throws IOException
```
    Close the ParcelFileDescriptor. This implementation closes the underlying OS resources allocated to represent this stream.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - If an error occurs attempting to close this ParcelFileDescriptor.
  - closeWithError
```
public void closeWithError(String msg)
                    throws IOException
```
    Close the ParcelFileDescriptor, informing any peer that an error occurred while processing. If the creator of this descriptor is not observing errors, it will close normally.
    
    Parameters:
    
    msg - describing the error; must not be null.
    
    Throws:
    
    IOException
  - releaseResources
```
public void releaseResources()
```
    Called when the fd is being closed, for subclasses to release any other resources associated with it, such as acquired providers.
  - canDetectErrors
```
public boolean canDetectErrors()
```
    Indicates if this ParcelFileDescriptor can communicate and detect remote errors/crashes.
    
    See Also:
    
    checkError()
  - checkError
```
public void checkError()
                throws IOException
```
    Detect and throw if the other end of a pipe or socket pair encountered an error or crashed. This allows a reader to distinguish between a valid EOF and an error/crash.
    If this ParcelFileDescriptor is unable to detect remote errors, it will return silently.
    
    Throws:
    
    IOException - for normal errors.
    
    ParcelFileDescriptor.FileDescriptorDetachedException - if the remote side called detachFd(). Once detached, the remote side is unable to communicate any errors through closeWithError(String).
    
    See Also:
    
    canDetectErrors()
  - toString
```
public String toString()
```
    Description copied from class: Object
    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.
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a printable representation of this object.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: Object
    
    Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
    Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.
    If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.
    Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.
    Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - describeContents
```
public int describeContents()
```
    Description copied from interface: Parcelable
    
    Describe the kinds of special objects contained in this Parcelable's marshalled representation.
    
    Specified by:
    
    describeContents in interface Parcelable
    
    Returns:
    
    a bitmask indicating the set of special object types marshalled by the Parcelable.
  - writeToParcel
```
public void writeToParcel(Parcel out,
                          int flags)
```
    Flatten this object in to a Parcel. If Parcelable.PARCELABLE_WRITE_RETURN_VALUE is set in flags, the file descriptor will be closed after a copy is written to the Parcel.
    
    Specified by:
    
    writeToParcel in interface Parcelable
    
    Parameters:
    
    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.PARCELABLE_WRITE_RETURN_VALUE.

Class ParcelFileDescriptor

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_WORLD_READABLE

MODE_WORLD_WRITEABLE

MODE_READ_ONLY

MODE_WRITE_ONLY

MODE_READ_WRITE

MODE_CREATE

MODE_TRUNCATE

MODE_APPEND

CREATOR

Constructor Detail

ParcelFileDescriptor

ParcelFileDescriptor

ParcelFileDescriptor

Method Detail

open

dup

dup

fromFd

adoptFd

fromSocket

fromDatagramSocket

createPipe

createReliablePipe

createSocketPair

createSocketPair

createReliableSocketPair

createReliableSocketPair

fromData

parseMode

getFileDescriptor

getStatSize

seekTo

getFd

detachFd

close

closeWithError

releaseResources

canDetectErrors

checkError

toString

finalize

describeContents

writeToParcel