Channels - Android SDK

Summary: Methods | Inherited Methods | [Expand All]

Added in API level 1

public final class

Channels

extends Object

java.lang.Object
↳	java.nio.channels.Channels

Class Overview

This class provides several utilities to get I/O streams from channels.

Summary

Public Methods
static WritableByteChannel	newChannel(OutputStream outputStream) Returns a writable channel on the given output stream.
static ReadableByteChannel	newChannel(InputStream inputStream) Returns a readable channel on the given input stream.
static InputStream	newInputStream(ReadableByteChannel channel) Returns an input stream on the given channel.
static OutputStream	newOutputStream(WritableByteChannel channel) Returns an output stream on the given channel.
static Reader	newReader(ReadableByteChannel channel, CharsetDecoder decoder, int minBufferCapacity) Returns a reader that decodes bytes from a channel.
static Reader	newReader(ReadableByteChannel channel, String charsetName) Returns a reader that decodes bytes from a channel.
static Writer	newWriter(WritableByteChannel channel, String charsetName) Returns a writer that encodes characters with the specified `encoder` and sends the bytes to the specified channel.
static Writer	newWriter(WritableByteChannel channel, CharsetEncoder encoder, int minBufferCapacity) Returns a writer that encodes characters with the specified `encoder` and sends the bytes to the specified channel.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	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.
final void	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.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public static WritableByteChannel newChannel (OutputStream outputStream)

Added in API level 1

Returns a writable channel on the given output stream. The resulting channel has following properties:

If the channel is closed, then the underlying stream is closed as well.
It is not buffered.

Parameters

outputStream	the stream to be wrapped by a byte channel.

Returns

a byte channel that writes bytes to the output stream.

public static ReadableByteChannel newChannel (InputStream inputStream)

Added in API level 1

Returns a readable channel on the given input stream. The resulting channel has the following properties:

If the channel is closed, then the underlying stream is closed as well.
It is not buffered.

Parameters

inputStream	the stream to be wrapped by a byte channel.

Returns

a byte channel that reads bytes from the input stream.

public static InputStream newInputStream (ReadableByteChannel channel)

Added in API level 1

Returns an input stream on the given channel. The resulting stream has the following properties:

If the stream is closed, then the underlying channel is closed as well.
It is thread safe.
It throws an IllegalBlockingModeException if the channel is in non-blocking mode and read is called.
Neither mark nor reset is supported.
It is not buffered.

Parameters

channel	the channel to be wrapped by an InputStream.

Returns

an InputStream that takes bytes from the given byte channel.

public static OutputStream newOutputStream (WritableByteChannel channel)

Added in API level 1

Returns an output stream on the given channel. The resulting stream has the following properties:

If the stream is closed, then the underlying channel is closed as well.
It is thread safe.
It throws an IllegalBlockingModeException if the channel is in non-blocking mode and write is called.
It is not buffered.

Parameters

channel	the channel to be wrapped by an OutputStream.

Returns

an OutputStream that puts bytes onto the given byte channel.

public static Reader newReader (ReadableByteChannel channel, CharsetDecoder decoder, int minBufferCapacity)

Added in API level 1

Returns a reader that decodes bytes from a channel.

Parameters

channel	the Channel to be read.
decoder	the Charset decoder to be used.
minBufferCapacity	The minimum size of the byte buffer, -1 means to use the default size.

Returns

the reader.

public static Reader newReader (ReadableByteChannel channel, String charsetName)

Added in API level 1

Returns a reader that decodes bytes from a channel. This method creates a reader with a buffer of default size.

Parameters

channel	the Channel to be read.
charsetName	the name of the charset.

Returns

the reader.

Throws

UnsupportedCharsetException	if the given charset name is not supported.

public static Writer newWriter (WritableByteChannel channel, String charsetName)

Added in API level 1

Returns a writer that encodes characters with the specified encoder and sends the bytes to the specified channel. This method creates a writer with a buffer of default size.

Parameters

channel	the Channel to be written to.
charsetName	the name of the charset.

Returns

the writer.

Throws

UnsupportedCharsetException	if the given charset name is not supported.

public static Writer newWriter (WritableByteChannel channel, CharsetEncoder encoder, int minBufferCapacity)

Added in API level 1

Returns a writer that encodes characters with the specified encoder and sends the bytes to the specified channel.

Parameters

channel	the Channel to write to.
encoder	the CharsetEncoder to be used.
minBufferCapacity	the minimum size of the byte buffer, -1 means to use the default size.

Returns

the writer.

Results

Interfaces

Classes

Exceptions

Channels

Class Overview

Summary

Public Methods

public static WritableByteChannel newChannel (OutputStream outputStream)

Parameters

Returns

public static ReadableByteChannel newChannel (InputStream inputStream)

Parameters

Returns

public static InputStream newInputStream (ReadableByteChannel channel)

Parameters

Returns

public static OutputStream newOutputStream (WritableByteChannel channel)

Parameters

Returns

public static Reader newReader (ReadableByteChannel channel, CharsetDecoder decoder, int minBufferCapacity)

Parameters

Returns

public static Reader newReader (ReadableByteChannel channel, String charsetName)

Parameters

Returns

Throws

public static Writer newWriter (WritableByteChannel channel, String charsetName)

Parameters

Returns

Throws

public static Writer newWriter (WritableByteChannel channel, CharsetEncoder encoder, int minBufferCapacity)

Parameters

Returns