com.squareup.wire

Class ByteString

java.lang.Object

com.squareup.wire.ByteString

public final class ByteString
extends Object

An immutable sequence of bytes.

Full disclosure: this class provides untrusted input and output streams with raw access to the underlying byte array. A hostile stream implementation could keep a reference to the mutable byte string, violating the immutable guarantee of this class. For this reason a byte string's immutability guarantee cannot be relied upon for security in applets and other environments that run both trusted and untrusted code in the same process.

Field Summary

Fields

Modifier and Type	Field and Description
static ByteString	EMPTY A singleton empty ByteString.

Method Summary

Methods

Modifier and Type	Method and Description
byte	byteAt(int index)
boolean	equals(Object o)
int	hashCode()
static ByteString	of(byte... data) Returns a new byte string containing the bytes of data.
static ByteString	of(byte[] data, int offset, int count) Returns a new byte string containing the bytes of data from offset to offset + count - 1, inclusive.
static ByteString	of(String data) Returns a new byte string containing the bytes of data, interpreted as Base64.
static ByteString	read(InputStream in, int count) Reads count bytes from in and returns the result.
int	size() Returns the number of bytes in this ByteString.
byte[]	toByteArray() Returns a byte array containing a copy of the bytes in this ByteString.
String	toString() Returns a string containing the contents of this ByteString in Base64 format.
void	write(OutputStream out) Writes the contents of this byte string to out.
void	write(OutputStream out, int offset, int count) Writes a subsequence of this byte string to out.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ByteString EMPTY

A singleton empty ByteString.

Method Detail

of

public static ByteString of(byte... data)

Returns a new byte string containing the bytes of data.

of

public static ByteString of(byte[] data,
            int offset,
            int count)

Returns a new byte string containing the bytes of data from offset to offset + count - 1, inclusive.

of

public static ByteString of(String data)

Returns a new byte string containing the bytes of data, interpreted as Base64.

read

public static ByteString read(InputStream in,
              int count)
                       throws IOException

Reads count bytes from in and returns the result.

Throws:

EOFException - if in has fewer than count bytes to read.

IOException

byteAt

public byte byteAt(int index)

size

public int size()

Returns the number of bytes in this ByteString.

toByteArray

public byte[] toByteArray()

Returns a byte array containing a copy of the bytes in this ByteString.

write

public void write(OutputStream out)
           throws IOException

Writes the contents of this byte string to out.

Throws:

IOException

write

public void write(OutputStream out,
         int offset,
         int count)
           throws IOException

Writes a subsequence of this byte string to out.

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string containing the contents of this ByteString in Base64 format.

Overrides:

toString in class Object