OpenJDK 1.23 · jdk.jfr.internal.consumer.RecordingInput

Modifier and Type	Class and Description
private static class	RecordingInput.Block

Modifier and Type	Field and Description
private final int	blockSize
private RecordingInput.Block	currentBlock
private static final int	DEFAULT_BLOCK_SIZE
private RandomAccessFile	file
private final FileAccess	fileAccess
private String	filename
private long	pollCount
private long	position
private RecordingInput.Block	previousBlock
private long	size

Access	Constructor and Description
pack-priv	RecordingInput(File f, FileAccess fileAccess, int blockSize)
public	RecordingInput(File f, FileAccess fileAccess)

Method Summary

Modifier and Type	Method and Description
private final long	calculateBlockStart(long newPosition)
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public String	getFilename()
public long	getFileSize()
private void	initialize(File f)
public void	pollWait()
public final long	position()
public final void	position(long newPosition)
pack-priv void	positionPhysical(long position)
public final boolean	readBoolean() Implements java.io.DataInput.readBoolean. Reads one input byte and returns `true` if that byte is nonzero, `false` if that byte is zero.
public final byte	readByte() Implements java.io.DataInput.readByte. Reads and returns one input byte.
public char	readChar() Implements java.io.DataInput.readChar. Reads two input bytes and returns a `char` value.
public double	readDouble() Implements java.io.DataInput.readDouble. Reads eight input bytes and returns a `double` value.
public float	readFloat() Implements java.io.DataInput.readFloat. Reads four input bytes and returns a `float` value.
public final void	readFully(byte[] the buffer into which the data is read. dest, int an int specifying the offset in the data array `b`. offset, int an int specifying the number of bytes to read. length) Implements java.io.DataInput.readFully. Reads `len` bytes from an input stream.
public final void	readFully(byte[] the buffer into which the data is read. dst) Implements java.io.DataInput.readFully. Reads some bytes from an input stream and stores them into the buffer array `b`.
public int	readInt() Implements java.io.DataInput.readInt. Reads four input bytes and returns an `int` value.
public final String	readLine() Implements java.io.DataInput.readLine. Reads the next line of text from the input stream.
public long	readLong() Implements java.io.DataInput.readLong. Reads eight input bytes and returns a `long` value.
private long	readLongSlow()
pack-priv byte	readPhysicalByte()
pack-priv long	readPhysicalLong()
pack-priv int	readRawInt()
pack-priv long	readRawLong()
pack-priv short	readRawShort()
public short	readShort() Implements java.io.DataInput.readShort. Reads two input bytes and returns a `short` value.
public int	readUnsignedByte() Implements java.io.DataInput.readUnsignedByte. Reads one input byte, zero-extends it to type `int`, and returns the result, which is therefore in the range `0` through `255`.
public int	readUnsignedShort() Implements java.io.DataInput.readUnsignedShort. Reads two input bytes and returns an `int` value in the range `0` through `65535`.
public String	readUTF() Implements java.io.DataInput.readUTF. Reads in a string that has been encoded using a modified UTF-8 format.
public void	require(int minimumBytes, String errorMessage)
public void	setFile(Path path)
public void	setStreamed()
public void	setValidSize(long size)
pack-priv long	size()
public final int	skipBytes(int the number of bytes to be skipped. n) Implements java.io.DataInput.skipBytes. Makes an attempt to skip over `n` bytes of data from the input stream, discarding the skipped bytes.
private final long	trimToFileSize(long position)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

blockSize	back to summary
private final int blockSize

currentBlock	back to summary
private RecordingInput.Block currentBlock

DEFAULT_BLOCK_SIZE	back to summary
private static final int DEFAULT_BLOCK_SIZE

file	back to summary
private RandomAccessFile file

fileAccess	back to summary
private final FileAccess fileAccess

filename	back to summary
private String filename

pollCount	back to summary
private long pollCount

position	back to summary
private long position

previousBlock	back to summary
private RecordingInput.Block previousBlock

size	back to summary
private long size

RecordingInput	back to summary
pack-priv RecordingInput(File f, FileAccess fileAccess, int blockSize) throws IOException

RecordingInput	back to summary
public RecordingInput(File f, FileAccess fileAccess) throws IOException

Method Detail

calculateBlockStart	back to summary
private final long calculateBlockStart(long newPosition)

close back to summary

close	back to summary
public void close() throws IOException Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public void close() throws IOException

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

getFilename	back to summary
public String getFilename()

getFileSize	back to summary
public long getFileSize() throws IOException

initialize	back to summary
private void initialize(File f) throws IOException

pollWait	back to summary
public void pollWait() throws IOException

position	back to summary
public final long position()

position	back to summary
public final void position(long newPosition) throws IOException

positionPhysical	back to summary
pack-priv void positionPhysical(long position) throws IOException

readBoolean back to summary

readBoolean	back to summary
public final boolean readBoolean() throws IOException Implements java.io.DataInput.readBoolean. Doc from java.io.DataInput.readBoolean. Reads one input byte and returns `true` if that byte is nonzero, `false` if that byte is zero. This method is suitable for reading the byte written by the `writeBoolean` method of interface `DataOutput`. Returns:boolean the `boolean` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final boolean readBoolean() throws IOException

Implements java.io.DataInput.readBoolean.

Doc from java.io.DataInput.readBoolean.

Reads one input byte and returns true if that byte is nonzero, false if that byte is zero. This method is suitable for reading the byte written by the writeBoolean method of interface DataOutput.

Returns:boolean

the boolean value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readByte back to summary

readByte	back to summary
public final byte readByte() throws IOException Implements java.io.DataInput.readByte. Doc from java.io.DataInput.readByte. Reads and returns one input byte. The byte is treated as a signed value in the range `-128` through `127`, inclusive. This method is suitable for reading the byte written by the `writeByte` method of interface `DataOutput`. Returns:byte the 8-bit value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final byte readByte() throws IOException

Implements java.io.DataInput.readByte.

Doc from java.io.DataInput.readByte.

Reads and returns one input byte. The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput.

Returns:byte

the 8-bit value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readChar back to summary

readChar	back to summary
public char readChar() throws IOException Implements java.io.DataInput.readChar. Doc from java.io.DataInput.readChar. Reads two input bytes and returns a `char` value. Let `a` be the first byte read and `b` be the second byte. The value returned is: `(char)((a << 8) \| (b & 0xff))` This method is suitable for reading bytes written by the `writeChar` method of interface `DataOutput`. Returns:char the `char` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public char readChar() throws IOException

Implements java.io.DataInput.readChar.

Doc from java.io.DataInput.readChar.

Reads two input bytes and returns a char value. Let a be the first byte read and b be the second byte. The value returned is:

(char)((a << 8) | (b & 0xff))

This method is suitable for reading bytes written by the writeChar method of interface DataOutput.

Returns:char

the char value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readDouble back to summary

readDouble	back to summary
public double readDouble() throws IOException Implements java.io.DataInput.readDouble. Doc from java.io.DataInput.readDouble. Reads eight input bytes and returns a `double` value. It does this by first constructing a `long` value in exactly the manner of the `readLong` method, then converting this `long` value to a `double` in exactly the manner of the method `Double.longBitsToDouble`. This method is suitable for reading bytes written by the `writeDouble` method of interface `DataOutput`. Returns:double the `double` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public double readDouble() throws IOException

Implements java.io.DataInput.readDouble.

Doc from java.io.DataInput.readDouble.

Reads eight input bytes and returns a double value. It does this by first constructing a long value in exactly the manner of the readLong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput.

Returns:double

the double value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readFloat back to summary

readFloat	back to summary
public float readFloat() throws IOException Implements java.io.DataInput.readFloat. Doc from java.io.DataInput.readFloat. Reads four input bytes and returns a `float` value. It does this by first constructing an `int` value in exactly the manner of the `readInt` method, then converting this `int` value to a `float` in exactly the manner of the method `Float.intBitsToFloat`. This method is suitable for reading bytes written by the `writeFloat` method of interface `DataOutput`. Returns:float the `float` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public float readFloat() throws IOException

Implements java.io.DataInput.readFloat.

Doc from java.io.DataInput.readFloat.

Reads four input bytes and returns a float value. It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput.

Returns:float

the float value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readFully back to summary

readFully	back to summary
public final void readFully(byte[] dest, int offset, int length) throws IOException Implements java.io.DataInput.readFully. Doc from java.io.DataInput.readFully. Reads `len` bytes from an input stream. This method blocks until one of the following conditions occurs: `len` bytes of input data are available, in which case a normal return is made. End of file is detected, in which case an `EOFException` is thrown. An I/O error occurs, in which case an `IOException` other than `EOFException` is thrown. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. If `len` is zero, then no bytes are read. Otherwise, the first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Parameters dest:byte[] the buffer into which the data is read. offset:int an int specifying the offset in the data array `b`. length:int an int specifying the number of bytes to read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final void readFully(byte[] dest, int offset, int length) throws IOException

Implements java.io.DataInput.readFully.

Doc from java.io.DataInput.readFully.

Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

len bytes of input data are available, in which case a normal return is made.
End of file is detected, in which case an EOFException is thrown.
An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.

Parameters

dest:byte[]: the buffer into which the data is read.
offset:int: an int specifying the offset in the data array b.
length:int: an int specifying the number of bytes to read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readFully back to summary

readFully	back to summary
public final void readFully(byte[] dst) throws IOException Implements java.io.DataInput.readFully. Doc from java.io.DataInput.readFully. Reads some bytes from an input stream and stores them into the buffer array `b`. The number of bytes read is equal to the length of `b`. This method blocks until one of the following conditions occurs: `b.length` bytes of input data are available, in which case a normal return is made. End of file is detected, in which case an `EOFException` is thrown. An I/O error occurs, in which case an `IOException` other than `EOFException` is thrown. If `b` is `null`, a `NullPointerException` is thrown. If `b.length` is zero, then no bytes are read. Otherwise, the first byte read is stored into element `b[0]`, the next one into `b[1]`, and so on. If an exception is thrown from this method, then it may be that some but not all bytes of `b` have been updated with data from the input stream. Parameters dst:byte[] the buffer into which the data is read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final void readFully(byte[] dst) throws IOException

Implements java.io.DataInput.readFully.

Doc from java.io.DataInput.readFully.

Reads some bytes from an input stream and stores them into the buffer array b. The number of bytes read is equal to the length of b.

This method blocks until one of the following conditions occurs:

b.length bytes of input data are available, in which case a normal return is made.
End of file is detected, in which case an EOFException is thrown.
An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[0], the next one into b[1], and so on. If an exception is thrown from this method, then it may be that some but not all bytes of b have been updated with data from the input stream.

Parameters

dst:byte[]: the buffer into which the data is read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readInt back to summary

readInt	back to summary
public int readInt() throws IOException Implements java.io.DataInput.readInt. Doc from java.io.DataInput.readInt. Reads four input bytes and returns an `int` value. Let `a-d` be the first through fourth bytes read. The value returned is: `(((a & 0xff) << 24) \| ((b & 0xff) << 16) \| ((c & 0xff) << 8) \| (d & 0xff))` This method is suitable for reading bytes written by the `writeInt` method of interface `DataOutput`. Returns:int the `int` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int readInt() throws IOException

Implements java.io.DataInput.readInt.

Doc from java.io.DataInput.readInt.

Reads four input bytes and returns an int value. Let a-d be the first through fourth bytes read. The value returned is:

(((a & 0xff) << 24) | ((b & 0xff) << 16) |
 ((c & 0xff) <<  8) | (d & 0xff))

This method is suitable for reading bytes written by the writeInt method of interface DataOutput.

Returns:int

the int value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readLine back to summary

readLine	back to summary
public final String readLine() throws IOException Implements java.io.DataInput.readLine. Doc from java.io.DataInput.readLine. Reads the next line of text from the input stream. It reads successive bytes, converting each byte separately into a character, until it encounters a line terminator or end of file; the characters read are then returned as a `String`. Note that because this method processes bytes, it does not support input of the full Unicode character set. If end of file is encountered before even one byte can be read, then `null` is returned. Otherwise, each byte that is read is converted to type `char` by zero-extension. If the character `'\n'` is encountered, it is discarded and reading ceases. If the character `'\r'` is encountered, it is discarded and, if the following byte converts to the character `'\n'`, then that is discarded also; reading then ceases. If end of file is encountered before either of the characters `'\n'` and `'\r'` is encountered, reading ceases. Once reading has ceased, a `String` is returned that contains all the characters read and not discarded, taken in order. Note that every character in this string will have a value less than `\u0100`, that is, `(char)256`. Returns:String the next line of text from the input stream, or `null` if the end of file is encountered before a byte can be read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final String readLine() throws IOException

Implements java.io.DataInput.readLine.

Doc from java.io.DataInput.readLine.

Reads the next line of text from the input stream. It reads successive bytes, converting each byte separately into a character, until it encounters a line terminator or end of file; the characters read are then returned as a String. Note that because this method processes bytes, it does not support input of the full Unicode character set.

If end of file is encountered before even one byte can be read, then null is returned. Otherwise, each byte that is read is converted to type char by zero-extension. If the character '\n' is encountered, it is discarded and reading ceases. If the character '\r' is encountered, it is discarded and, if the following byte converts to the character '\n', then that is discarded also; reading then ceases. If end of file is encountered before either of the characters '\n' and '\r' is encountered, reading ceases. Once reading has ceased, a String is returned that contains all the characters read and not discarded, taken in order. Note that every character in this string will have a value less than \u0100, that is, (char)256.

Returns:String

the next line of text from the input stream, or null if the end of file is encountered before a byte can be read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readLong back to summary

readLong	back to summary
public long readLong() throws IOException Implements java.io.DataInput.readLong. Doc from java.io.DataInput.readLong. Reads eight input bytes and returns a `long` value. Let `a-h` be the first through eighth bytes read. The value returned is: `(((long)(a & 0xff) << 56) \| ((long)(b & 0xff) << 48) \| ((long)(c & 0xff) << 40) \| ((long)(d & 0xff) << 32) \| ((long)(e & 0xff) << 24) \| ((long)(f & 0xff) << 16) \| ((long)(g & 0xff) << 8) \| ((long)(h & 0xff)))` This method is suitable for reading bytes written by the `writeLong` method of interface `DataOutput`. Returns:long the `long` value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public long readLong() throws IOException

Implements java.io.DataInput.readLong.

Doc from java.io.DataInput.readLong.

Reads eight input bytes and returns a long value. Let a-h be the first through eighth bytes read. The value returned is:

(((long)(a & 0xff) << 56) |
 ((long)(b & 0xff) << 48) |
 ((long)(c & 0xff) << 40) |
 ((long)(d & 0xff) << 32) |
 ((long)(e & 0xff) << 24) |
 ((long)(f & 0xff) << 16) |
 ((long)(g & 0xff) <<  8) |
 ((long)(h & 0xff)))

This method is suitable for reading bytes written by the writeLong method of interface DataOutput.

Returns:long

the long value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readLongSlow	back to summary
private long readLongSlow() throws IOException

readPhysicalByte	back to summary
pack-priv byte readPhysicalByte() throws IOException

readPhysicalLong	back to summary
pack-priv long readPhysicalLong() throws IOException

readRawInt	back to summary
pack-priv int readRawInt() throws IOException

readRawLong	back to summary
pack-priv long readRawLong() throws IOException

readRawShort	back to summary
pack-priv short readRawShort() throws IOException

readShort back to summary

readShort	back to summary
public short readShort() throws IOException Implements java.io.DataInput.readShort. Doc from java.io.DataInput.readShort. Reads two input bytes and returns a `short` value. Let `a` be the first byte read and `b` be the second byte. The value returned is: `(short)((a << 8) \| (b & 0xff))` This method is suitable for reading the bytes written by the `writeShort` method of interface `DataOutput`. Returns:short the 16-bit value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public short readShort() throws IOException

Implements java.io.DataInput.readShort.

Doc from java.io.DataInput.readShort.

Reads two input bytes and returns a short value. Let a be the first byte read and b be the second byte. The value returned is:

(short)((a << 8) | (b & 0xff))

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput.

Returns:short

the 16-bit value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readUnsignedByte back to summary

readUnsignedByte	back to summary
public int readUnsignedByte() throws IOException Implements java.io.DataInput.readUnsignedByte. Doc from java.io.DataInput.readUnsignedByte. Reads one input byte, zero-extends it to type `int`, and returns the result, which is therefore in the range `0` through `255`. This method is suitable for reading the byte written by the `writeByte` method of interface `DataOutput` if the argument to `writeByte` was intended to be a value in the range `0` through `255`. Returns:int the unsigned 8-bit value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int readUnsignedByte() throws IOException

Implements java.io.DataInput.readUnsignedByte.

Doc from java.io.DataInput.readUnsignedByte.

Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255.

Returns:int

the unsigned 8-bit value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readUnsignedShort back to summary

readUnsignedShort	back to summary
public int readUnsignedShort() throws IOException Implements java.io.DataInput.readUnsignedShort. Doc from java.io.DataInput.readUnsignedShort. Reads two input bytes and returns an `int` value in the range `0` through `65535`. Let `a` be the first byte read and `b` be the second byte. The value returned is: `(((a & 0xff) << 8) \| (b & 0xff))` This method is suitable for reading the bytes written by the `writeShort` method of interface `DataOutput` if the argument to `writeShort` was intended to be a value in the range `0` through `65535`. Returns:int the unsigned 16-bit value read. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int readUnsignedShort() throws IOException

Implements java.io.DataInput.readUnsignedShort.

Doc from java.io.DataInput.readUnsignedShort.

Reads two input bytes and returns an int value in the range 0 through 65535. Let a be the first byte read and b be the second byte. The value returned is:

(((a & 0xff) << 8) | (b & 0xff))

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535.

Returns:int

the unsigned 16-bit value read.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readUTF back to summary

readUTF	back to summary
public String readUTF() throws IOException Implements java.io.DataInput.readUTF. Doc from java.io.DataInput.readUTF. Reads in a string that has been encoded using a modified UTF-8 format. The general contract of `readUTF` is that it reads a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a `String`. First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the `readUnsignedShort` method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group. If the first byte of a group matches the bit pattern `0xxxxxxx` (where `x` means "may be `0` or `1`"), then the group consists of just that byte. The byte is zero-extended to form a character. If the first byte of a group matches the bit pattern `110xxxxx`, then the group consists of that byte `a` and a second byte `b`. If there is no byte `b` (because byte `a` was the last of the bytes to be read), or if byte `b` does not match the bit pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. Otherwise, the group is converted to the character: `(char)(((a & 0x1F) << 6) \| (b & 0x3F))` If the first byte of a group matches the bit pattern `1110xxxx`, then the group consists of that byte `a` and two more bytes `b` and `c`. If there is no byte `c` (because byte `a` was one of the last two of the bytes to be read), or either byte `b` or byte `c` does not match the bit pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. Otherwise, the group is converted to the character: `(char)(((a & 0x0F) << 12) \| ((b & 0x3F) << 6) \| (c & 0x3F))` If the first byte of a group matches the pattern `1111xxxx` or the pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. If end of file is encountered at any time during this entire process, then an `EOFException` is thrown. After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a `String`, which is returned. The `writeUTF` method of interface `DataOutput` may be used to write data that is suitable for reading by this method. Returns:String a Unicode string. Annotations @Override Exceptions IOException: if an I/O error occurs.

public String readUTF() throws IOException

Implements java.io.DataInput.readUTF.

Doc from java.io.DataInput.readUTF.

Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the readUnsignedShort method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group.

If the first byte of a group matches the bit pattern 0xxxxxxx (where x means "may be 0 or 1"), then the group consists of just that byte. The byte is zero-extended to form a character.

If the first byte of a group matches the bit pattern 110xxxxx, then the group consists of that byte a and a second byte b. If there is no byte b (because byte a was the last of the bytes to be read), or if byte b does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a & 0x1F) << 6) | (b & 0x3F))

If the first byte of a group matches the bit pattern 1110xxxx, then the group consists of that byte a and two more bytes b and c. If there is no byte c (because byte a was one of the last two of the bytes to be read), or either byte b or byte c does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))

If the first byte of a group matches the pattern 1111xxxx or the pattern 10xxxxxx, then a UTFDataFormatException is thrown.

If end of file is encountered at any time during this entire process, then an EOFException is thrown.

After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a String, which is returned.

The writeUTF method of interface DataOutput may be used to write data that is suitable for reading by this method.

Returns:String

a Unicode string.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

require	back to summary
public void require(int minimumBytes, String errorMessage) throws IOException

setFile	back to summary
public void setFile(Path path) throws IOException

setStreamed	back to summary
public void setStreamed()

setValidSize	back to summary
public void setValidSize(long size)

size	back to summary
pack-priv long size()

skipBytes back to summary

public final int skipBytes(int n) throws IOException

Implements java.io.DataInput.skipBytes.

Doc from java.io.DataInput.skipBytes.

Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes. However, it may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. This method never throws an EOFException. The actual number of bytes skipped is returned.

Parameters

n:int: the number of bytes to be skipped.

Returns:int

the number of bytes actually skipped.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

trimToFileSize	back to summary
private final long trimToFileSize(long position) throws IOException

Modifier and Type	Method and Description
pack-priv boolean	contains(long position)
public byte	get(long position)
public void	read(RandomAccessFile file, int amount)
public void	reset()

public final Class RecordingInput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class RecordingInput.Block

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private long	blockPosition
private long	blockPositionEnd
private byte[]	bytes