Package org.apache.commons.io.channels

Class FilterByteChannel<C extends ByteChannel>

java.lang.Object

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

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

Type Parameters:

C - the ByteChannel type.

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, WritableByteChannel

Direct Known Subclasses:

FilterSeekableByteChannel

public class FilterByteChannel<C extends ByteChannel>
extends FilterChannel<C>
implements ByteChannel

A ByteChannel filter which delegates to the wrapped ByteChannel.

A FilterByteChannel 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 FilterByteChannel itself simply overrides methods of ByteChannel with versions that pass all requests to the wrapped channel. Subclasses of FilterByteChannel may of course override any methods declared or inherited by FilterByteChannel, and may also provide additional fields and methods.

You construct s simple instance with the channel constructor and more advanced instances through the FilterByteChannel.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	FilterByteChannel.AbstractBuilder<F extends FilterByteChannel<C>,C extends ByteChannel,B extends FilterByteChannel.AbstractBuilder<F,C,B>>	Builds instances of FilterByteChannel for subclasses.
static class	FilterByteChannel.Builder	Builds instances of FilterByteChannel.

Constructor Summary

Constructors

Constructor	Description
FilterByteChannel(C byteChannel)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static FilterByteChannel.Builder	forByteChannel()	Creates a new FilterByteChannel.Builder.
int	read(ByteBuffer dst)
int	write(ByteBuffer src)

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

FilterByteChannel

public FilterByteChannel(C byteChannel)

Constructs a new instance.

Parameters:

byteChannel - The channel to wrap.

Method Details

forByteChannel

public static FilterByteChannel.Builder forByteChannel()

Creates a new FilterByteChannel.Builder.

Returns:

a new FilterByteChannel.Builder.

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Throws:

IOException