FileChannel FileChannel Class

Definition

An abstract channel type for interaction with a platform file.

[Android.Runtime.Register("java/nio/channels/FileChannel", ApiSince=1, DoNotGenerateAcw=true)]
public abstract class FileChannel : Java.Nio.Channels.Spi.AbstractInterruptibleChannel, IDisposable, Java.Nio.Channels.IGatheringByteChannel, Java.Nio.Channels.IScatteringByteChannel, Java.Nio.Channels.ISeekableByteChannel
type FileChannel = class
    inherit AbstractInterruptibleChannel
    interface IByteChannel
    interface IReadableByteChannel
    interface IChannel
    interface ICloseable
    interface IJavaObject
    interface IDisposable
    interface IWritableByteChannel
    interface IGatheringByteChannel
    interface IScatteringByteChannel
    interface ISeekableByteChannel
Inheritance
Attributes
Implements

Remarks

Android platform documentation

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

FileChannel() FileChannel()

Protected default constructor.

FileChannel(IntPtr, JniHandleOwnership) FileChannel(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class Class

Returns the unique instance of Class that represents this object's class.

(Inherited from Object)
Handle Handle

The handle to the underlying Android instance.

(Inherited from Object)
IJavaObjectEx.IsProxy IJavaObjectEx.IsProxy Inherited from Object
IJavaObjectEx.KeyHandle IJavaObjectEx.KeyHandle Inherited from Object
IJavaObjectEx.NeedsActivation IJavaObjectEx.NeedsActivation Inherited from Object
IJavaPeerable.JniManagedPeerState IJavaPeerable.JniManagedPeerState Inherited from Object
IsOpen IsOpen

Returns true if this channel is open.

(Inherited from AbstractInterruptibleChannel)
JniIdentityHashCode JniIdentityHashCode Inherited from Object
JniPeerMembers JniPeerMembers
PeerReference PeerReference Inherited from Object
ThresholdClass ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Begin() Begin()

Indicates the beginning of a code section that includes an I/O operation that is potentially blocking.

(Inherited from AbstractInterruptibleChannel)
Clone() Clone()

Creates and returns a copy of this Object.

(Inherited from Object)
Close() Close()

Closes an open channel.

(Inherited from AbstractInterruptibleChannel)
Dispose() Dispose() Inherited from Object
Dispose(Boolean) Dispose(Boolean) Inherited from Object
End(Boolean) End(Boolean)

Indicates the end of a code section that has been started with begin() and that includes a potentially blocking I/O operation.

(Inherited from AbstractInterruptibleChannel)
Equals(Object) Equals(Object)

Compares this instance with the specified object and indicates if they are equal.

(Inherited from Object)
Force(Boolean) Force(Boolean)

Requests that all updates to this channel are committed to the storage device.

ForceAsync(Boolean) ForceAsync(Boolean)
GetHashCode() GetHashCode()

Returns an integer hash code for this object.

(Inherited from Object)
ImplCloseChannel() ImplCloseChannel()

Implements the channel closing behavior.

(Inherited from AbstractInterruptibleChannel)
JavaFinalize() JavaFinalize()

Invoked when the garbage collector has detected that this instance is no longer reachable.

(Inherited from Object)
Lock() Lock()

Obtains an exclusive lock on this file.

Lock(Int64, Int64, Boolean) Lock(Int64, Int64, Boolean)

Obtains a lock on a specified region of the file.

Map(FileChannel+MapMode, Int64, Int64) Map(FileChannel+MapMode, Int64, Int64)

Maps the file into memory.

Notify() Notify()

Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
NotifyAll() NotifyAll()

Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
Open(IPath, ICollection<IOpenOption>, IFileAttribute[]) Open(IPath, ICollection<IOpenOption>, IFileAttribute[])
Open(IPath, IOpenOption[]) Open(IPath, IOpenOption[])
Position() Position()

Returns the current position as a positive integer number of bytes from the start of the file.

Position(Int64) Position(Int64)

Sets the file position pointer to a new value.

Read(ByteBuffer) Read(ByteBuffer)

Reads bytes from this file channel into the given buffer.

Read(ByteBuffer, Int64) Read(ByteBuffer, Int64)

Reads bytes from this file channel into the given buffer starting from the specified file position.

Read(ByteBuffer[]) Read(ByteBuffer[])

Reads bytes from this file channel and stores them in the specified array of buffers.

Read(ByteBuffer[], Int32, Int32) Read(ByteBuffer[], Int32, Int32)

Reads bytes from this file channel into a subset of the given buffers.

ReadAsync(ByteBuffer) ReadAsync(ByteBuffer)
ReadAsync(ByteBuffer, Int64) ReadAsync(ByteBuffer, Int64)
ReadAsync(ByteBuffer[]) ReadAsync(ByteBuffer[])
ReadAsync(ByteBuffer[], Int32, Int32) ReadAsync(ByteBuffer[], Int32, Int32)
SetHandle(IntPtr, JniHandleOwnership) SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
Size() Size()

Returns the size of the file underlying this channel in bytes.

ToArray<T>() ToArray<T>() Inherited from Object
ToString() ToString()

Returns a string containing a concise, human-readable description of this object.

(Inherited from Object)
TransferFrom(IReadableByteChannel, Int64, Int64) TransferFrom(IReadableByteChannel, Int64, Int64)

Reads up to count bytes from src and stores them in this channel's file starting at position.

TransferFromAsync(IReadableByteChannel, Int64, Int64) TransferFromAsync(IReadableByteChannel, Int64, Int64)
TransferTo(Int64, Int64, IWritableByteChannel) TransferTo(Int64, Int64, IWritableByteChannel)

Reads up to count bytes from this channel's file starting at position and writes them to target.

TransferToAsync(Int64, Int64, IWritableByteChannel) TransferToAsync(Int64, Int64, IWritableByteChannel)
Truncate(Int64) Truncate(Int64)

Truncates the file underlying this channel to a given size.

TruncateAsync(Int64) TruncateAsync(Int64)
TryLock() TryLock()

Attempts to acquire an exclusive lock on this file without blocking.

TryLock(Int64, Int64, Boolean) TryLock(Int64, Int64, Boolean)

Attempts to acquire an exclusive lock on this file without blocking.

UnregisterFromRuntime() UnregisterFromRuntime() Inherited from Object
Wait() Wait()

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

(Inherited from Object)
Wait(Int64) Wait(Int64)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)
Wait(Int64, Int32) Wait(Int64, Int32)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)
Write(ByteBuffer) Write(ByteBuffer)

Writes bytes from the given byte buffer to this file channel.

Write(ByteBuffer, Int64) Write(ByteBuffer, Int64)

Writes bytes from the given buffer to this file channel starting at the given file position.

Write(ByteBuffer[]) Write(ByteBuffer[])

Writes bytes from all the given byte buffers to this file channel.

Write(ByteBuffer[], Int32, Int32) Write(ByteBuffer[], Int32, Int32)

Attempts to write a subset of the given bytes from the buffers to this file channel.

WriteAsync(ByteBuffer) WriteAsync(ByteBuffer)
WriteAsync(ByteBuffer, Int64) WriteAsync(ByteBuffer, Int64)
WriteAsync(ByteBuffer[]) WriteAsync(ByteBuffer[])
WriteAsync(ByteBuffer[], Int32, Int32) WriteAsync(ByteBuffer[], Int32, Int32)

Explicit Interface Implementations

IJavaObjectEx.ToLocalJniHandle() IJavaObjectEx.ToLocalJniHandle() Inherited from Object
IJavaPeerable.Disposed() IJavaPeerable.Disposed() Inherited from Object
IJavaPeerable.DisposeUnlessReferenced() IJavaPeerable.DisposeUnlessReferenced() Inherited from Object
IJavaPeerable.Finalized() IJavaPeerable.Finalized() Inherited from Object
IJavaPeerable.SetJniIdentityHashCode(Int32) IJavaPeerable.SetJniIdentityHashCode(Int32) Inherited from Object
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) Inherited from Object
IJavaPeerable.SetPeerReference(JniObjectReference) IJavaPeerable.SetPeerReference(JniObjectReference) Inherited from Object
ISeekableByteChannel.Position(Int64) ISeekableByteChannel.Position(Int64)
ISeekableByteChannel.Truncate(Int64) ISeekableByteChannel.Truncate(Int64)

Extension Methods

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable) GetJniTypeName(IJavaPeerable)
WriteAsync(IGatheringByteChannel, ByteBuffer[]) WriteAsync(IGatheringByteChannel, ByteBuffer[])
WriteAsync(IGatheringByteChannel, ByteBuffer[], Int32, Int32) WriteAsync(IGatheringByteChannel, ByteBuffer[], Int32, Int32)
ReadAsync(IReadableByteChannel, ByteBuffer) ReadAsync(IReadableByteChannel, ByteBuffer)
ReadAsync(IScatteringByteChannel, ByteBuffer[]) ReadAsync(IScatteringByteChannel, ByteBuffer[])
ReadAsync(IScatteringByteChannel, ByteBuffer[], Int32, Int32) ReadAsync(IScatteringByteChannel, ByteBuffer[], Int32, Int32)
WriteAsync(IWritableByteChannel, ByteBuffer) WriteAsync(IWritableByteChannel, ByteBuffer)

Applies to