Package org.apache.commons.io.channels

Class FilterReadableByteChannel<C extends ReadableByteChannel>

java.lang.Object

org.apache.commons.io.channels.FilterChannel<C>

org.apache.commons.io.channels.FilterReadableByteChannel<C>

Type Parameters:

C - the ReadableByteChannel type.

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel

public class FilterReadableByteChannel<C extends ReadableByteChannel>
extends FilterChannel<C>
implements ReadableByteChannel

A ReadableByteChannel filter which delegates to the wrapped ReadableByteChannel.

A FilterReadableByteChannel wraps some other channel, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterReadableByteChannel itself simply overrides methods of ReadableByteChannel with versions that pass all requests to the wrapped channel. Subclasses of FilterReadableByteChannel may of course override any methods declared or inherited by FilterReadableByteChannel, and may also provide additional fields and methods.

You construct s simple instance with the channel constructor and more advanced instances through the FilterReadableByteChannel.Builder.

Since:

2.22.0

See Also:

• FilterInputStream
• FilterOutputStream
• FilterReader
• FilterWritableByteChannel
• ProxyInputStream
• ProxyOutputStream
• ProxyReader
• ProxyWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterReadableByteChannel.AbstractBuilder<F extends FilterReadableByteChannel<C>,C extends ReadableByteChannel,B extends FilterReadableByteChannel.AbstractBuilder<F,C,B>>	Builds instances of FilterReadableByteChannel for subclasses.
static class	FilterReadableByteChannel.Builder	Builds instances of FilterByteChannel.

Constructor Summary

Constructors

Constructor	Description
FilterReadableByteChannel(C channel)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static FilterReadableByteChannel.Builder	forReadableByteChannel()	Creates a new FilterReadableByteChannel.Builder.
int	read(ByteBuffer dst)

Methods inherited from class org.apache.commons.io.channels.FilterChannel

close, forChannel, isOpen, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Constructor Details

FilterReadableByteChannel

public FilterReadableByteChannel(C channel)

Constructs a new instance.

Parameters:

channel - The channel to wrap.

Method Details

forReadableByteChannel

public static FilterReadableByteChannel.Builder forReadableByteChannel()

Creates a new FilterReadableByteChannel.Builder.

Returns:

a new FilterReadableByteChannel.Builder.

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException