net.sf.kdgcommons.io

Class ChannelInputStream

java.lang.Object

java.io.InputStream

net.sf.kdgcommons.io.ChannelInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ChannelInputStream
extends InputStream

A decorator that provides InputStream operations backed by a java.nio.Channel. This allows programs to use the flexibility of the channel API (such as random seeks on FileChannel) while still using the java.io class hierarchy (in particular, InputStreamReader).

This class does not attempt to replicate channel functionality. The program shouldmaintain an independent reference to the channel to support operations such as position(). See method docs for cases where stream functionality overlaps channel functionality.

Single instances of this class are not safe for concurrent use by multiple threads. Multiple instances that share a channel are thread-safe if the channel is thread-safe.

Constructor Summary

Constructors

Constructor and Description
ChannelInputStream(ReadableByteChannel channel)

Method Summary

Modifier and Type	Method and Description
int	available() Deprecated.
void	close() Deprecated.
boolean	markSupported() Always returns false.
int	read() Reads a single byte from the channel.
int	read(byte[] b) Attempts to fill the passed array from the channel, returning the number of bytes read (which may be 0), or -1 to indicate end-of-file.
int	read(byte[] b, int off, int len) Attempts to fill a section of the passed array from the channel, returning the number of bytes read (which may be 0), or -1 to indicate end-of-file.
long	skip(long n) Deprecated.

Methods inherited from class java.io.InputStream

mark, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelInputStream

public ChannelInputStream(ReadableByteChannel channel)

Method Detail

markSupported

public boolean markSupported()

Always returns false. If the underlying channel supports marks and positioning, you should perform those operations there.

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Reads a single byte from the channel. Returns the byte's value, or -1 to indicate either end-of-file or no bytes available on channel.

Unlike the InputStream implementations in java.io, end-of-file is "soft": some channels will increase their size. As a result, you can call this method after receiving end-of-file notification and get valid data.

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Attempts to fill the passed array from the channel, returning the number of bytes read (which may be 0), or -1 to indicate end-of-file.

Unlike the InputStream implementations in java.io, end-of-file is "soft": some channels will increase their size. As a result, you can call this method after receiving end-of-file notification and get valid data.

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Attempts to fill a section of the passed array from the channel, returning the number of bytes read (which may be 0), or -1 to indicate end-of-file.

Unlike the InputStream implementations in java.io, end-of-file is "soft": some channels will increase their size. As a result, you can call this method after receiving end-of-file notification and get valid data.

Overrides:

read in class InputStream

Throws:

IOException

close

@Deprecated
public void close()
                       throws IOException

Deprecated.

Closes this stream, along with the underlying channel.

It is generally a better idea to close the channel explicitly; there is no need to close the stream (which is a decorator).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

available

@Deprecated
public int available()
                          throws IOException

Deprecated.

This method always returns 0; there is no way to discover the number of available bytes from a generic channel.

Overrides:

available in class InputStream

Throws:

IOException

skip

@Deprecated
public long skip(long n)
                      throws IOException

Deprecated.

Attempts to skip the specified number of bytes from the channel.

This method is deprecated; you should adjust the channel's position rather than skipping bytes (the former is guaranteed, unlike the latter).

Overrides:

skip in class InputStream

Throws:

IOException