BufferedReadOnlyChannel (TrueCommons I/O 2.3.4 API)

java.lang.Object
- net.java.truecommons.io.AbstractSeekableChannel
- - net.java.truecommons.io.DecoratingSeekableChannel
  - - net.java.truecommons.io.ReadOnlyChannel
    - - net.java.truecommons.io.BufferedReadOnlyChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, SeekableByteChannel, WritableByteChannel
```
@NotThreadSafe
public class BufferedReadOnlyChannel
extends ReadOnlyChannel
```
Provides buffered random read-only access to its decorated seekable byte channel. Note that this channel implements its own virtual position.

Author:

Christian Schlichtherle

Field Summary
- Fields inherited from class net.java.truecommons.io.DecoratingSeekableChannel
  channel

Constructor Summary

Constructors
Constructor and Description
`BufferedReadOnlyChannel(SeekableByteChannel channel)` Constructs a new buffered read-only channel.
`BufferedReadOnlyChannel(SeekableByteChannel channel, int bufferSize)` Constructs a new buffered read-only channel.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`position()`
`SeekableByteChannel`	`position(long pos)`
`int`	`read(ByteBuffer dst)`
`BufferedReadOnlyChannel`	`sync()` Notifies this channel of concurrent changes in its decorated channel.

Methods inherited from class net.java.truecommons.io.ReadOnlyChannel
truncate, write

Methods inherited from class net.java.truecommons.io.DecoratingSeekableChannel
close, isOpen, size, toString

Methods inherited from class net.java.truecommons.io.AbstractSeekableChannel
checkOpen

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BufferedReadOnlyChannel
```
@CreatesObligation
public BufferedReadOnlyChannel(@WillCloseWhenClosed
                                         SeekableByteChannel channel)
```
    Constructs a new buffered read-only channel.
    
    Parameters:
    channel - the channel to decorate.
  - BufferedReadOnlyChannel
```
@CreatesObligation
public BufferedReadOnlyChannel(@WillCloseWhenClosed
                                         SeekableByteChannel channel,
                                         int bufferSize)
```
    Constructs a new buffered read-only channel.
    
    Parameters:
    channel - the channel to decorate.
    bufferSize - the size of the byte buffer.
- Method Detail
  - position
```
public long position()
              throws IOException
```
    Specified by:
    
    position in interface SeekableByteChannel
    
    Overrides:
    
    position in class DecoratingSeekableChannel
    
    Throws:
    
    IOException
  - position
```
public SeekableByteChannel position(long pos)
                             throws IOException
```
    Specified by:
    
    position in interface SeekableByteChannel
    
    Overrides:
    
    position in class DecoratingSeekableChannel
    
    Throws:
    
    IOException
  - read
```
public int read(ByteBuffer dst)
         throws IOException
```
    Specified by:
    
    read in interface ReadableByteChannel
    
    Specified by:
    
    read in interface SeekableByteChannel
    
    Overrides:
    
    read in class DecoratingSeekableChannel
    
    Throws:
    
    IOException
  - sync
```
public BufferedReadOnlyChannel sync()
```
    Notifies this channel of concurrent changes in its decorated channel. Calling this method triggers a reload of the buffer on the next read access.
    
    Returns:
    this

Class BufferedReadOnlyChannel

Field Summary

Fields inherited from class net.java.truecommons.io.DecoratingSeekableChannel

Constructor Summary

Method Summary

Methods inherited from class net.java.truecommons.io.ReadOnlyChannel

Methods inherited from class net.java.truecommons.io.DecoratingSeekableChannel

Methods inherited from class net.java.truecommons.io.AbstractSeekableChannel

Methods inherited from class java.lang.Object

Constructor Detail

BufferedReadOnlyChannel

BufferedReadOnlyChannel

Method Detail

position

position

read

sync