com.google.crypto.tink.subtle

Class RewindableReadableByteChannel

java.lang.Object

com.google.crypto.tink.subtle.RewindableReadableByteChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel

public final class RewindableReadableByteChannel
extends Object
implements ReadableByteChannel

A wrapper around ReadableByteChannel that provides rewinding feature: it caches the read bytes so that after reading some initial part of the channel, one can "rewind" the channel and again read the bytes from the beginning. Once the rewinding feature is not needed any more, it can be disabled via disableRewinding(): this frees the cache memory and forwadrds the subsequent read(java.nio.ByteBuffer)-calls directly to the wrapped channel.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
RewindableReadableByteChannel(ReadableByteChannel baseChannel) Constructs a wrapper around baseChannel.

Method Summary

Modifier and Type	Method and Description
void	close()
void	disableRewinding() Disables the rewinding feature.
boolean	isOpen()
int	read(ByteBuffer dst)
void	rewind() Rewinds this buffer to the beginning (if rewinding is still enabled).

Methods inherited from class java.lang.Object

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

Constructor Detail

RewindableReadableByteChannel

public RewindableReadableByteChannel(ReadableByteChannel baseChannel)

Constructs a wrapper around baseChannel. After wrapping baseChannel should not be manipulated externally.

Method Detail

disableRewinding

public void disableRewinding()

Disables the rewinding feature. After calling this method the attempts to rewind this channel will fail, and the subsequent read()-calls will be forwarded directly to the wrapped channel (after the currently buffered bytes are read).

rewind

public void rewind()
            throws IOException

Rewinds this buffer to the beginning (if rewinding is still enabled).

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel