ByteString (Okio (Parent) 1.2.0 API)

java.lang.Object
- okio.ByteString

All Implemented Interfaces:

Serializable
```
public final class ByteString
extends Object
implements Serializable
```
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.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static ByteString EMPTY
A singleton empty ByteString.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`base64()` Returns this byte string encoded as Base64.
`static ByteString`	`decodeBase64(String base64)` Decodes the Base64-encoded bytes and returns their value as a byte string.
`static ByteString`	`decodeHex(String hex)` Decodes the hex-encoded bytes and returns their value a byte string.
`static ByteString`	`encodeUtf8(String s)` Returns a new byte string containing the `UTF-8` bytes of `s`.
`boolean`	`equals(Object o)`
`byte`	`getByte(int pos)` Returns the byte at `pos`.
`int`	`hashCode()`
`String`	`hex()` Returns this byte string encoded in hexadecimal.
`static ByteString`	`of(byte... data)` Returns a new byte string containing a clone of the bytes of `data`.
`static ByteString`	`of(byte[] data, int offset, int byteCount)` Returns a new byte string containing a copy of `byteCount` bytes of `data` starting at `offset`.
`static ByteString`	`read(InputStream in, int byteCount)` Reads `count` bytes from `in` and returns the result.
`int`	`size()` Returns the number of bytes in this ByteString.
`ByteString`	`toAsciiLowercase()` Returns a byte string equal to this byte string, but with the bytes 'A' through 'Z' replaced with the corresponding byte in 'a' through 'z'.
`ByteString`	`toAsciiUppercase()` Returns a byte string equal to this byte string, but with the bytes 'a' through 'z' replaced with the corresponding byte in 'A' through 'Z'.
`byte[]`	`toByteArray()` Returns a byte array containing a copy of the bytes in this `ByteString`.
`String`	`toString()`
`String`	`utf8()` Constructs a new `String` by decoding the bytes as `UTF-8`.
`void`	`write(OutputStream out)` Writes the contents 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 a clone of the bytes of data.
  - of
```
public static ByteString of(byte[] data,
                            int offset,
                            int byteCount)
```
    Returns a new byte string containing a copy of byteCount bytes of data starting at offset.
  - encodeUtf8
```
public static ByteString encodeUtf8(String s)
```
    Returns a new byte string containing the UTF-8 bytes of s.
  - utf8
```
public String utf8()
```
    Constructs a new String by decoding the bytes as UTF-8.
  - base64
```
public String base64()
```
    Returns this byte string encoded as Base64. In violation of the RFC, the returned string does not wrap lines at 76 columns.
  - decodeBase64
```
public static ByteString decodeBase64(String base64)
```
    Decodes the Base64-encoded bytes and returns their value as a byte string. Returns null if base64 is not a Base64-encoded sequence of bytes.
  - hex
```
public String hex()
```
    Returns this byte string encoded in hexadecimal.
  - decodeHex
```
public static ByteString decodeHex(String hex)
```
    Decodes the hex-encoded bytes and returns their value a byte string.
  - read
```
public static ByteString read(InputStream in,
                              int byteCount)
                       throws IOException
```
    Reads count bytes from in and returns the result.
    
    Throws:
    
    EOFException - if in has fewer than count bytes to read.
    
    IOException
  - toAsciiLowercase
```
public ByteString toAsciiLowercase()
```
    Returns a byte string equal to this byte string, but with the bytes 'A' through 'Z' replaced with the corresponding byte in 'a' through 'z'. Returns this byte string if it contains no bytes in 'A' through 'Z'.
  - toAsciiUppercase
```
public ByteString toAsciiUppercase()
```
    Returns a byte string equal to this byte string, but with the bytes 'a' through 'z' replaced with the corresponding byte in 'A' through 'Z'. Returns this byte string if it contains no bytes in 'a' through 'z'.
  - getByte
```
public byte getByte(int pos)
```
    Returns the byte at pos.
  - 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
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ByteString

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Method Detail

of

of

encodeUtf8

utf8

base64

decodeBase64

hex

decodeHex

read

toAsciiLowercase

toAsciiUppercase

getByte

size

toByteArray

write

equals

hashCode

toString