ByteSequence

net.corda.core.utilities.ByteSequence

Direct Known Subclasses:

OpaqueBytes
```
public class ByteSequence
```
An abstraction of a byte array, with offset and size that does no copying of bytes unless asked to.
The data of interest typically starts at position offset within the bytes and is size bytes long.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ByteSequence.Companion

Nested Classes
Modifier and Type	Class and Description
`static class`	`ByteSequence.Companion`

Field Summary

Fields
Modifier and Type Field and Description

static ByteSequence.Companion Companion

Fields
Modifier and Type	Field and Description
`static ByteSequence.Companion`	`Companion`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ByteSequence other)` Compare byte arrays byte by byte. Arrays that are shorter are deemed less than longer arrays if all the bytes of the shorter array equal those in the same position of the longer array.
`ByteSequence`	`copy()` Copy this sequence, complete with new backing array. This can be helpful to break references to potentially large backing arrays from small sub-sequences.
`boolean`	`equals(java.lang.Object other)`
`byte[]`	`getBytes()` The underlying bytes.
`int`	`getOffset()` The start position of the sequence within the byte array.
`int`	`getSize()` The number of bytes this sequence represents.
`int`	`hashCode()`
`static ByteSequence`	`of(byte[] bytes, int offset, int size)` Construct a `class ByteSequence` given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
`static ByteSequence`	`of(byte[] bytes, int offset)` Construct a `class ByteSequence` given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
`static ByteSequence`	`of(byte[] bytes)` Construct a `class ByteSequence` given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
`java.io.ByteArrayInputStream`	`open()` Returns a ByteArrayInputStream of the bytes
`ByteSequence`	`subSequence(int offset, int size)` Create a sub-sequence backed by the same array.
`ByteSequence`	`take(int n)` Take the first n bytes of this sequence as a sub-sequence. See subSequence for further semantics.
`java.lang.String`	`toString()`

- Field Detail
  - Companion
```
public static ByteSequence.Companion Companion
```
- Method Detail
  - getBytes
```
public byte[] getBytes()
```
    The underlying bytes.
  - getSize
```
public int getSize()
```
    The number of bytes this sequence represents.
  - getOffset
```
public int getOffset()
```
    The start position of the sequence within the byte array.
  - open
```
public java.io.ByteArrayInputStream open()
```
    Returns a ByteArrayInputStream of the bytes
    
    See Also:
    
    ByteArrayInputStream
  - subSequence
```
public ByteSequence subSequence(int offset,
                                int size)
```
    Create a sub-sequence backed by the same array.
    
    Parameters:
    
    offset - The offset within this sequence to start the new sequence. Note: not the offset within the backing array.
    
    size - The size of the intended sub sequence.
  - take
```
public ByteSequence take(int n)
```
    Take the first n bytes of this sequence as a sub-sequence. See subSequence for further semantics.
  - copy
```
public ByteSequence copy()
```
    Copy this sequence, complete with new backing array. This can be helpful to break references to potentially large backing arrays from small sub-sequences.
  - compareTo
```
public int compareTo(ByteSequence other)
```
    Compare byte arrays byte by byte. Arrays that are shorter are deemed less than longer arrays if all the bytes of the shorter array equal those in the same position of the longer array.
  - equals
```
public boolean equals(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
  - toString
```
public java.lang.String toString()
```
  - of
```
public static ByteSequence of(byte[] bytes,
                              int offset,
                              int size)
```
    Construct a class ByteSequence given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
    
    See Also:
    
    class ByteSequence, ByteArray, ByteArray
  - of
```
public static ByteSequence of(byte[] bytes,
                              int offset)
```
    Construct a class ByteSequence given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
    
    See Also:
    
    class ByteSequence, ByteArray, ByteArray
  - of
```
public static ByteSequence of(byte[] bytes)
```
    Construct a class ByteSequence given a ByteArray and optional offset and size, that represents that potentially sub-sequence of bytes. The returned implementation is optimised when the whole ByteArray is the sequence.
    
    See Also:
    
    class ByteSequence, ByteArray, ByteArray

Class ByteSequence

Nested Class Summary

Field Summary

Method Summary

Field Detail

Companion

Method Detail

getBytes

getSize

getOffset

open

subSequence

take

copy

compareTo

equals

hashCode

toString

of

of

of