org.apache.calcite.avatica.util

Class ByteString

java.lang.Object

org.apache.calcite.avatica.util.ByteString

All Implemented Interfaces:

Serializable, Comparable<ByteString>

public class ByteString
extends Object
implements Comparable<ByteString>, Serializable

Collection of bytes.

ByteString is to bytes what String is to chars: It is immutable, implements equality (hashCode() and equals(java.lang.Object)), comparison (compareTo(org.apache.calcite.avatica.util.ByteString)) and serialization correctly.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ByteString	EMPTY An empty byte string.

Constructor Summary

Constructors

Constructor and Description
ByteString(byte[] bytes) Creates a ByteString.

Method Summary

Methods

Modifier and Type	Method and Description
byte	byteAt(int i) Returns the byte at a given position in the byte string.
Object	clone()
int	compareTo(ByteString that)
ByteString	concat(ByteString other) Returns a ByteString consisting of the concatenation of this and another string.
boolean	equals(Object obj)
byte[]	getBytes() Returns a copy of the byte array.
int	hashCode()
int	indexOf(ByteString seek) Returns the position at which seek first occurs in this byte string, or -1 if it does not occur.
int	length() Returns the number of bytes in this byte string.
ByteString	substring(int start) Returns a ByteString that starts at a given position.
ByteString	substring(int start, int end) Returns a ByteString that consists of a given range.
String	toString() Returns this byte string in hexadecimal format.
static String	toString(byte[] bytes, int base) Returns the given byte array in hexadecimal format.
String	toString(int base) Returns this byte string in a given base.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final ByteString EMPTY

An empty byte string.

Constructor Detail

ByteString

public ByteString(byte[] bytes)

Creates a ByteString.

Parameters:

bytes - Bytes

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ByteString that)

Specified by:

compareTo in interface Comparable<ByteString>

toString

public String toString()

Returns this byte string in hexadecimal format.

Overrides:

toString in class Object

Returns:

Hexadecimal string

toString

public String toString(int base)

Returns this byte string in a given base.

Returns:

String in given base

toString

public static String toString(byte[] bytes,
              int base)

Returns the given byte array in hexadecimal format.

For example, toString(new byte[] {0xDE, 0xAD}) returns "DEAD".

Parameters:

bytes - Array of bytes

base - Base (2 or 16)

Returns:

String

clone

public Object clone()

Overrides:

clone in class Object

length

public int length()

Returns the number of bytes in this byte string.

Returns:

Length of this byte string

byteAt

public byte byteAt(int i)

Returns the byte at a given position in the byte string.

Parameters:

i - Index

Returns:

Byte at given position

Throws:

IndexOutOfBoundsException - if the index argument is negative or not less than length()

substring

public ByteString substring(int start,
                   int end)

Returns a ByteString that consists of a given range.

Parameters:

start - Start of range

end - Position after end of range

Returns:

Substring

substring

public ByteString substring(int start)

Returns a ByteString that starts at a given position.

Parameters:

start - Start of range

Returns:

Substring

getBytes

public byte[] getBytes()

Returns a copy of the byte array.

concat

public ByteString concat(ByteString other)

Returns a ByteString consisting of the concatenation of this and another string.

Parameters:

other - Byte string to concatenate

Returns:

Combined byte string

indexOf

public int indexOf(ByteString seek)

Returns the position at which seek first occurs in this byte string, or -1 if it does not occur.