SegmentedByteString

java.lang.Object
- okio.ByteString
- - okio.SegmentedByteString

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ByteString>
```
final class SegmentedByteString
extends ByteString
```
An immutable byte string composed of segments of byte arrays. This class exists to implement efficient snapshots of buffers. It is implemented as an array of segments, plus a directory in two halves that describes how the segments compose this byte string.
The first half of the directory is the cumulative byte count covered by each segment. The element at directory[0] contains the number of bytes held in segments[0]; the element at directory[1] contains the number of bytes held in segments[0] + segments[1], and so on. The element at directory[segments.length - 1] contains the total size of this byte string. The first half of the directory is always monotonically increasing.
The second half of the directory is the offset in segments of the first content byte. Bytes preceding this offset are unused, as are bytes beyond the segment's effective size.
Suppose we have a byte string, [A, B, C, D, E, F, G, H, I, J, K, L, M] that is stored across three byte arrays: [x, x, x, x, A, B, C, D, E, x, x, x], [x, F, G], and [H, I, J, K, L, M, x, x, x, x, x, x]. The three byte arrays would be stored in segments in order. Since the arrays contribute 5, 2, and 6 elements respectively, the directory starts with [5, 7, 13 to hold the cumulative total at each position. Since the offsets into the arrays are 4, 1, and 0 respectively, the directory ends with 4, 1, 0]. Concatenating these two halves, the complete directory is [5, 7, 13, 4, 1, 0].
This structure is chosen so that the segment holding a particular offset can be found by binary search. We use one array rather than two for the directory as a micro-optimization.

Field Summary

Fields
Modifier and Type Field and Description

(package private) int[] directory

(package private) byte[][] segments
- Fields inherited from class okio.ByteString
  data, EMPTY, hashCode, HEX_DIGITS, utf8

Fields
Modifier and Type	Field and Description
`(package private) int[]`	`directory`
`(package private) byte[][]`	`segments`

Constructor Summary

Constructors
Constructor and Description

SegmentedByteString(Buffer buffer, int byteCount)

Constructors
Constructor and Description
`SegmentedByteString(Buffer buffer, int byteCount)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.nio.ByteBuffer`	`asByteBuffer()` Returns a `ByteBuffer` view of the bytes in this `ByteString`.
`java.lang.String`	`base64()` Returns this byte string encoded as Base64.
`java.lang.String`	`base64Url()` Returns this byte string encoded as URL-safe Base64.
`boolean`	`equals(java.lang.Object o)`
`byte`	`getByte(int pos)` Returns the byte at `pos`.
`int`	`hashCode()`
`java.lang.String`	`hex()` Returns this byte string encoded in hexadecimal.
`ByteString`	`hmacSha1(ByteString key)` Returns the 160-bit SHA-1 HMAC of this byte string.
`ByteString`	`hmacSha256(ByteString key)` Returns the 256-bit SHA-256 HMAC of this byte string.
`int`	`indexOf(byte[] other, int fromIndex)`
`(package private) byte[]`	`internalArray()` Returns the bytes of this string without a defensive copy.
`int`	`lastIndexOf(byte[] other, int fromIndex)`
`ByteString`	`md5()` Returns the 128-bit MD5 hash of this byte string.
`boolean`	`rangeEquals(int offset, byte[] other, int otherOffset, int byteCount)` Returns true if the bytes of this in `[offset..offset+byteCount)` equal the bytes of `other` in `[otherOffset..otherOffset+byteCount)`.
`boolean`	`rangeEquals(int offset, ByteString other, int otherOffset, int byteCount)` Returns true if the bytes of this in `[offset..offset+byteCount)` equal the bytes of `other` in `[otherOffset..otherOffset+byteCount)`.
`private int`	`segment(int pos)` Returns the index of the segment that contains the byte at `pos`.
`ByteString`	`sha1()` Returns the 160-bit SHA-1 hash of this byte string.
`ByteString`	`sha256()` Returns the 256-bit SHA-256 hash of this byte string.
`int`	`size()` Returns the number of bytes in this ByteString.
`java.lang.String`	`string(java.nio.charset.Charset charset)` Constructs a new `String` by decoding the bytes using `charset`.
`ByteString`	`substring(int beginIndex)` Returns a byte string that is a substring of this byte string, beginning at the specified index until the end of this string.
`ByteString`	`substring(int beginIndex, int endIndex)` Returns a byte string that is a substring of this byte string, beginning at the specified `beginIndex` and ends at the specified `endIndex`.
`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`.
`private ByteString`	`toByteString()` Returns a copy as a non-segmented byte string.
`java.lang.String`	`toString()` Returns a human-readable string that describes the contents of this byte string.
`java.lang.String`	`utf8()` Constructs a new `String` by decoding the bytes as `UTF-8`.
`(package private) void`	`write(Buffer buffer)` Writes the contents of this byte string to `buffer`.
`void`	`write(java.io.OutputStream out)` Writes the contents of this byte string to `out`.
`private java.lang.Object`	`writeReplace()`

Methods inherited from class okio.ByteString
codePointIndexToCharIndex, compareTo, decodeBase64, decodeHex, encodeString, encodeUtf8, endsWith, endsWith, hmacSha512, indexOf, indexOf, indexOf, lastIndexOf, lastIndexOf, lastIndexOf, of, of, of, read, sha512, startsWith, startsWith

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - segments
```
final transient byte[][] segments
```
  - directory
```
final transient int[] directory
```
- Constructor Detail
  - SegmentedByteString
```
SegmentedByteString(Buffer buffer,
                    int byteCount)
```
- Method Detail
  - utf8
```
public java.lang.String utf8()
```
    Description copied from class: ByteString
    
    Constructs a new String by decoding the bytes as UTF-8.
    
    Overrides:
    
    utf8 in class ByteString
  - string
```
public java.lang.String string(java.nio.charset.Charset charset)
```
    Description copied from class: ByteString
    
    Constructs a new String by decoding the bytes using charset.
    
    Overrides:
    
    string in class ByteString
  - base64
```
public java.lang.String base64()
```
    Description copied from class: ByteString
    
    Returns this byte string encoded as Base64. In violation of the RFC, the returned string does not wrap lines at 76 columns.
    
    Overrides:
    
    base64 in class ByteString
  - hex
```
public java.lang.String hex()
```
    Description copied from class: ByteString
    
    Returns this byte string encoded in hexadecimal.
    
    Overrides:
    
    hex in class ByteString
  - toAsciiLowercase
```
public ByteString toAsciiLowercase()
```
    Description copied from class: ByteString
    
    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'.
    
    Overrides:
    
    toAsciiLowercase in class ByteString
  - toAsciiUppercase
```
public ByteString toAsciiUppercase()
```
    Description copied from class: ByteString
    
    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'.
    
    Overrides:
    
    toAsciiUppercase in class ByteString
  - md5
```
public ByteString md5()
```
    Description copied from class: ByteString
    
    Returns the 128-bit MD5 hash of this byte string.
    
    Overrides:
    
    md5 in class ByteString
  - sha1
```
public ByteString sha1()
```
    Description copied from class: ByteString
    
    Returns the 160-bit SHA-1 hash of this byte string.
    
    Overrides:
    
    sha1 in class ByteString
  - sha256
```
public ByteString sha256()
```
    Description copied from class: ByteString
    
    Returns the 256-bit SHA-256 hash of this byte string.
    
    Overrides:
    
    sha256 in class ByteString
  - hmacSha1
```
public ByteString hmacSha1(ByteString key)
```
    Description copied from class: ByteString
    
    Returns the 160-bit SHA-1 HMAC of this byte string.
    
    Overrides:
    
    hmacSha1 in class ByteString
  - hmacSha256
```
public ByteString hmacSha256(ByteString key)
```
    Description copied from class: ByteString
    
    Returns the 256-bit SHA-256 HMAC of this byte string.
    
    Overrides:
    
    hmacSha256 in class ByteString
  - base64Url
```
public java.lang.String base64Url()
```
    Description copied from class: ByteString
    
    Returns this byte string encoded as URL-safe Base64.
    
    Overrides:
    
    base64Url in class ByteString
  - substring
```
public ByteString substring(int beginIndex)
```
    Description copied from class: ByteString
    
    Returns a byte string that is a substring of this byte string, beginning at the specified index until the end of this string. Returns this byte string if beginIndex is 0.
    
    Overrides:
    
    substring in class ByteString
  - substring
```
public ByteString substring(int beginIndex,
                            int endIndex)
```
    Description copied from class: ByteString
    
    Returns a byte string that is a substring of this byte string, beginning at the specified beginIndex and ends at the specified endIndex. Returns this byte string if beginIndex is 0 and endIndex is the length of this byte string.
    
    Overrides:
    
    substring in class ByteString
  - getByte
```
public byte getByte(int pos)
```
    Description copied from class: ByteString
    
    Returns the byte at pos.
    
    Overrides:
    
    getByte in class ByteString
  - segment
```
private int segment(int pos)
```
    Returns the index of the segment that contains the byte at pos.
  - size
```
public int size()
```
    Description copied from class: ByteString
    
    Returns the number of bytes in this ByteString.
    
    Overrides:
    
    size in class ByteString
  - toByteArray
```
public byte[] toByteArray()
```
    Description copied from class: ByteString
    
    Returns a byte array containing a copy of the bytes in this ByteString.
    
    Overrides:
    
    toByteArray in class ByteString
  - asByteBuffer
```
public java.nio.ByteBuffer asByteBuffer()
```
    Description copied from class: ByteString
    
    Returns a ByteBuffer view of the bytes in this ByteString.
    
    Overrides:
    
    asByteBuffer in class ByteString
  - write
```
public void write(java.io.OutputStream out)
           throws java.io.IOException
```
    Description copied from class: ByteString
    
    Writes the contents of this byte string to out.
    
    Overrides:
    
    write in class ByteString
    
    Throws:
    
    java.io.IOException
  - write
```
void write(Buffer buffer)
```
    Description copied from class: ByteString
    
    Writes the contents of this byte string to buffer.
    
    Overrides:
    
    write in class ByteString
  - rangeEquals
```
public boolean rangeEquals(int offset,
                           ByteString other,
                           int otherOffset,
                           int byteCount)
```
    Description copied from class: ByteString
    
    Returns true if the bytes of this in [offset..offset+byteCount) equal the bytes of other in [otherOffset..otherOffset+byteCount). Returns false if either range is out of bounds.
    
    Overrides:
    
    rangeEquals in class ByteString
  - rangeEquals
```
public boolean rangeEquals(int offset,
                           byte[] other,
                           int otherOffset,
                           int byteCount)
```
    Description copied from class: ByteString
    
    Returns true if the bytes of this in [offset..offset+byteCount) equal the bytes of other in [otherOffset..otherOffset+byteCount). Returns false if either range is out of bounds.
    
    Overrides:
    
    rangeEquals in class ByteString
  - indexOf
```
public int indexOf(byte[] other,
                   int fromIndex)
```
    Overrides:
    
    indexOf in class ByteString
  - lastIndexOf
```
public int lastIndexOf(byte[] other,
                       int fromIndex)
```
    Overrides:
    
    lastIndexOf in class ByteString
  - toByteString
```
private ByteString toByteString()
```
    Returns a copy as a non-segmented byte string.
  - internalArray
```
byte[] internalArray()
```
    Description copied from class: ByteString
    
    Returns the bytes of this string without a defensive copy. Do not mutate!
    
    Overrides:
    
    internalArray in class ByteString
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class ByteString
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ByteString
  - toString
```
public java.lang.String toString()
```
    Description copied from class: ByteString
    
    Returns a human-readable string that describes the contents of this byte string. Typically this is a string like [text=Hello] or [hex=0000ffff].
    
    Overrides:
    
    toString in class ByteString
  - writeReplace
```
private java.lang.Object writeReplace()
```

Class SegmentedByteString

Field Summary

Fields inherited from class okio.ByteString

Constructor Summary

Method Summary

Methods inherited from class okio.ByteString

Methods inherited from class java.lang.Object

Field Detail

segments

directory

Constructor Detail

SegmentedByteString

Method Detail

utf8

string

base64

hex

toAsciiLowercase

toAsciiUppercase

md5

sha1

sha256

hmacSha1

hmacSha256

base64Url

substring

substring

getByte

segment

size

toByteArray

asByteBuffer

write

write

rangeEquals

rangeEquals

indexOf

lastIndexOf

toByteString

internalArray

equals

hashCode

toString

writeReplace