Package org.apache.cassandra.io.util

Class RandomAccessReader

java.lang.Object

java.io.InputStream

org.apache.cassandra.io.util.DataInputPlus.DataInputStreamPlus

org.apache.cassandra.io.util.RebufferingInputStream

org.apache.cassandra.io.util.RandomAccessReader

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable, DataInputPlus, FileDataInput, RewindableDataInput

Direct Known Subclasses:

RandomAccessReaderAdapter

@NotThreadSafe
public class RandomAccessReader
extends RebufferingInputStream
implements FileDataInput

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.io.util.DataInputPlus

DataInputPlus.DataInputStreamPlus

Field Summary

Fields

Modifier and Type	Field	Description
protected Rebufferer.BufferHolder	bufferHolder
static final int	DEFAULT_BUFFER_SIZE

Fields inherited from class org.apache.cassandra.io.util.RebufferingInputStream

buffer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RandomAccessReader(Rebufferer rebufferer)	Only created through Builder

Method Summary

Modifier and Type	Method	Description
int	available()
long	bytesPastMark()
long	bytesPastMark(DataPosition mark)
long	bytesRemaining()
void	close()
protected long	current()
ChannelProxy	getChannel()
double	getCrcCheckChance()
long	getFilePointer()
String	getPath()
long	getPosition()
boolean	isEOF()
long	length()
DataPosition	mark()
boolean	markSupported()
static RandomAccessReader	open(File file)	Open a RandomAccessReader (not compressed, not mmapped, no read throttling) that will own its channel.
final String	readLine()	Reads a line of text form the current position in this file.
void	reBuffer()	Read data from file starting from current currentOffset to populate buffer.
void	reset()
void	reset(DataPosition mark)
void	seek(long newPosition)
int	skipBytes(int n)	Always skips the requested number of bytes, unless EOF is reached
String	toString()

Methods inherited from class org.apache.cassandra.io.util.RebufferingInputStream

read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readFully, readInt, readLong, readPrimitiveSlowly, readShort, readUnsignedByte, readUnsignedShort, readUnsignedVInt, readUnsignedVInt32, readUTF, readVInt, readVInt32

Methods inherited from class java.io.InputStream

mark, nullInputStream, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF

Methods inherited from interface org.apache.cassandra.io.util.DataInputPlus

readUnsignedVInt, readUnsignedVInt32, readVInt, readVInt32, skipBytesFully

Field Details

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

bufferHolder

protected Rebufferer.BufferHolder bufferHolder

Constructor Details

RandomAccessReader

protected RandomAccessReader(Rebufferer rebufferer)

Only created through Builder

Parameters:

rebufferer - Rebufferer to use

Method Details

reBuffer

public void reBuffer()

Read data from file starting from current currentOffset to populate buffer.

Specified by:

reBuffer in class RebufferingInputStream

getFilePointer

public long getFilePointer()

Specified by:

getFilePointer in interface FileDataInput

current

protected long current()

getPath

public String getPath()

Specified by:

getPath in interface FileDataInput

getChannel

public ChannelProxy getChannel()

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

bytesPastMark

public long bytesPastMark()

mark

public DataPosition mark()

Specified by:

mark in interface RewindableDataInput

reset

public void reset(DataPosition mark)

Specified by:

reset in interface RewindableDataInput

bytesPastMark

public long bytesPastMark(DataPosition mark)

Specified by:

bytesPastMark in interface RewindableDataInput

isEOF

public boolean isEOF()

Specified by:

isEOF in interface FileDataInput

Returns:

true if there is no more data to read

bytesRemaining

public long bytesRemaining()

Specified by:

bytesRemaining in interface FileDataInput

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

toString

public String toString()

Overrides:

toString in class Object

seek

public void seek(long newPosition)

Specified by:

seek in interface FileDataInput

skipBytes

public int skipBytes(int n)
              throws IOException

Description copied from interface: DataInputPlus

Always skips the requested number of bytes, unless EOF is reached

Specified by:

skipBytes in interface DataInput

Specified by:

skipBytes in interface DataInputPlus

Overrides:

skipBytes in class RebufferingInputStream

Parameters:

n - number of bytes to skip

Returns:

number of bytes skipped

Throws:

IOException

readLine

public final String readLine()
                      throws IOException

Reads a line of text form the current position in this file. A line is represented by zero or more characters followed by '\n', '\r', "\r\n" or the end of file marker. The string does not include the line terminating sequence.

Blocks until a line terminating sequence has been read, the end of the file is reached or an exception is thrown.

Specified by:

readLine in interface DataInput

Overrides:

readLine in class RebufferingInputStream

Returns:

the contents of the line or null if no characters have been read before the end of the file has been reached.

Throws:

IOException - if this file is closed or another I/O error occurs.

length

public long length()

getPosition

public long getPosition()

getCrcCheckChance

public double getCrcCheckChance()

open

public static RandomAccessReader open(File file)

Open a RandomAccessReader (not compressed, not mmapped, no read throttling) that will own its channel.

Parameters:

file - File to open for reading

Returns:

new RandomAccessReader that owns the channel opened in this method.