Package com.google.common.geometry

Interface PrimitiveArrays.Bytes

Enclosing class:

PrimitiveArrays

public static interface PrimitiveArrays.Bytes

An array of bytes.

Implementations will be thread-safe if the underlying data is not mutated. Users should ensure the underlying data is not mutated in order to get predictable behaviour. Any buffering should be done internally.

Implementations may support arrays > 2GB in size like so:

 new Bytes() {
   byte get(long position) {
     if (position < b1.length) {
       return b1[Ints.checkedCast(position)];
     }
     return b2[Ints.checkedCast(position - b2.length)];
   }
   long length() { return b1.length + b2.length; }
 }
 

Method Summary

Modifier and Type	Method	Description
default PrimitiveArrays.Cursor	cursor()	Returns a PrimitiveArrays.Cursor.
default PrimitiveArrays.Cursor	cursor(long position)	Returns a PrimitiveArrays.Cursor with the given position.
default PrimitiveArrays.Cursor	cursor(long position, long limit)	Returns a PrimitiveArrays.Cursor with the given position and limit.
static PrimitiveArrays.Bytes	fromByteArray(byte[] bytes)	Returns a PrimitiveArrays.Bytes wrapping bytes.
static PrimitiveArrays.Bytes	fromByteBuffer(ByteBuffer buffer)	Returns a PrimitiveArrays.Bytes wrapping buffer.
byte	get(long position)	Returns the byte at position position.
long	length()	Returns the length of this array.
default double	readLittleEndianDouble(long position)	Returns a little-endian double read from this array at position.
default long	readUintWithLength(long position, int numBytes)	Same as readUintWithLength(Cursor, int), but does not require a PrimitiveArrays.Cursor.
default long	readUintWithLength(PrimitiveArrays.Cursor cursor, int numBytes)	Returns a unsigned integer consisting of numBytes bytes read from this array at cursor.position in little-endian format as an unsigned 64-bit integer.
default int	readVarint32(PrimitiveArrays.Cursor cursor)	Same as readVarint64(Cursor), but throws an IllegalArgumentException if the read varint64 is greater than Integer.MAX_VALUE.
default long	readVarint64(PrimitiveArrays.Cursor cursor)	Returns a unsigned integer consisting of numBytes bytes read from this array at cursor.position in little-endian format as an unsigned 64-bit integer.
default InputStream	toInputStream()	Returns an InputStream wrapping this array starting at the 0th byte.
default InputStream	toInputStream(long offset)	Returns an InputStream wrapping this array starting at offset.
default InputStream	toInputStream(PrimitiveArrays.Cursor cursor)	Returns an InputStream wrapping this array starting at cursor.position.
default void	writeTo(OutputStream output)	Writes this array to output.

Method Detail

get

byte get(long position)

Returns the byte at position position.

Throws an IndexOutOfBoundsException if the absolute get on the underlying implementation fails.

length

long length()

Returns the length of this array.

cursor

default PrimitiveArrays.Cursor cursor(long position,
                                      long limit)

Returns a PrimitiveArrays.Cursor with the given position and limit.

cursor

default PrimitiveArrays.Cursor cursor(long position)

Returns a PrimitiveArrays.Cursor with the given position.

The limit of the returned cursor is the length() of this array.

cursor

default PrimitiveArrays.Cursor cursor()

Returns a PrimitiveArrays.Cursor.

The position of the returned cursor is 0, and the limit is the length() of this array.

fromByteBuffer

@GwtIncompatible("ByteBuffer")
static PrimitiveArrays.Bytes fromByteBuffer(ByteBuffer buffer)

Returns a PrimitiveArrays.Bytes wrapping buffer.

The returned array starts from index 0 of buffer, and its length is buffer.limit().

fromByteArray

static PrimitiveArrays.Bytes fromByteArray(byte[] bytes)

Returns a PrimitiveArrays.Bytes wrapping bytes.

toInputStream

default InputStream toInputStream(long offset)

Returns an InputStream wrapping this array starting at offset.

toInputStream

default InputStream toInputStream(PrimitiveArrays.Cursor cursor)

Returns an InputStream wrapping this array starting at cursor.position.

cursor.position is incremented for each byte read from the returned InputStream.

toInputStream

default InputStream toInputStream()

Returns an InputStream wrapping this array starting at the 0th byte.

writeTo

default void writeTo(OutputStream output)
              throws IOException

Writes this array to output.

Throws:

IOException

readVarint64

default long readVarint64(PrimitiveArrays.Cursor cursor)

Returns a unsigned integer consisting of numBytes bytes read from this array at cursor.position in little-endian format as an unsigned 64-bit integer.

cursor.position is updated to the index of the first byte following the varint64.

readVarint32

default int readVarint32(PrimitiveArrays.Cursor cursor)

Same as readVarint64(Cursor), but throws an IllegalArgumentException if the read varint64 is greater than Integer.MAX_VALUE.

readUintWithLength

default long readUintWithLength(PrimitiveArrays.Cursor cursor,
                                int numBytes)

Returns a unsigned integer consisting of numBytes bytes read from this array at cursor.position in little-endian format as an unsigned 64-bit integer.

cursor.position is updated to the index of the first byte following the uint.

This method is not compatible with readVarint64(Cursor).

readUintWithLength

default long readUintWithLength(long position,
                                int numBytes)

Same as readUintWithLength(Cursor, int), but does not require a PrimitiveArrays.Cursor.

readLittleEndianDouble

default double readLittleEndianDouble(long position)

Returns a little-endian double read from this array at position.