Bytes (Atomix API Reference (2.0.19))

All Superinterfaces:

AutoCloseable, BytesInput<Bytes>, BytesOutput<Bytes>

All Known Implementing Classes:

AbstractBytes, ByteBufferBytes, DirectBytes, FileBytes, HeapBytes, MappedBytes, NativeBytes, SwappedBytes, UnsafeDirectBytes, UnsafeHeapBytes, UnsafeMappedBytes, WrappedBytes
```
public interface Bytes
extends BytesInput<Bytes>, BytesOutput<Bytes>, AutoCloseable
```
Common interface for interacting with a memory or disk based array of bytes.

Author:

Jordan Halterman

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOLEAN`
`static int`	`BYTE`
`static int`	`CHARACTER`
`static int`	`DOUBLE`
`static int`	`FLOAT`
`static int`	`INTEGER`
`static int`	`LONG`
`static int`	`MEDIUM`
`static int`	`SHORT`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default byte[]`	`array()` Returns the underlying byte array.
`void`	`close()`
`default boolean`	`hasArray()` Returns whether the bytes has an array.
`boolean`	`isDirect()` Returns a boolean value indicating whether the bytes are direct.
`boolean`	`isFile()` Returns a boolean value indicating whether the bytes are backed by a file.
`ByteOrder`	`order()` Returns the byte order.
`Bytes`	`order(ByteOrder order)` Sets the byte order, returning a new swapped `Bytes` instance.
`Bytes`	`resize(int newSize)` Resizes the bytes.
`int`	`size()` Returns the count of the bytes.

Methods inherited from interface io.atomix.storage.buffer.BytesInput
read, read, readBoolean, readByte, readChar, readDouble, readFloat, readInt, readLong, readMedium, readShort, readString, readString, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, readUTF8

Methods inherited from interface io.atomix.storage.buffer.BytesOutput
flush, write, write, writeBoolean, writeByte, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writeShort, writeString, writeString, writeUnsignedByte, writeUnsignedInt, writeUnsignedMedium, writeUnsignedShort, writeUTF8, zero, zero, zero

- Field Detail
  - BYTE
```
static final int BYTE
```
    See Also:
    
    Constant Field Values
  - BOOLEAN
```
static final int BOOLEAN
```
    See Also:
    
    Constant Field Values
  - CHARACTER
```
static final int CHARACTER
```
    See Also:
    
    Constant Field Values
  - SHORT
```
static final int SHORT
```
    See Also:
    
    Constant Field Values
  - MEDIUM
```
static final int MEDIUM
```
    See Also:
    
    Constant Field Values
  - INTEGER
```
static final int INTEGER
```
    See Also:
    
    Constant Field Values
  - LONG
```
static final int LONG
```
    See Also:
    
    Constant Field Values
  - FLOAT
```
static final int FLOAT
```
    See Also:
    
    Constant Field Values
  - DOUBLE
```
static final int DOUBLE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - hasArray
```
default boolean hasArray()
```
    Returns whether the bytes has an array.
    
    Returns:
    
    Whether the bytes has an underlying array.
  - array
```
default byte[] array()
```
    Returns the underlying byte array.
    
    Returns:
    
    the underlying byte array
    
    Throws:
    
    UnsupportedOperationException - if a heap array is not supported
  - size
```
int size()
```
    Returns the count of the bytes.
    
    Returns:
    
    The count of the bytes.
  - resize
```
Bytes resize(int newSize)
```
    Resizes the bytes.
    When the bytes are resized, underlying memory addresses in copies of this instance may no longer be valid. Additionally, if the newSize is smaller than the current count then some data may be lost during the resize. Use with caution.
    
    Parameters:
    
    newSize - The count to which to resize this instance.
    
    Returns:
    
    The resized bytes.
  - order
```
ByteOrder order()
```
    Returns the byte order.
    For consistency with ByteBuffer, all bytes implementations are initially in ByteOrder.BIG_ENDIAN order.
    
    Returns:
    
    The byte order.
  - order
```
Bytes order(ByteOrder order)
```
    Sets the byte order, returning a new swapped Bytes instance.
    By default, all bytes are read and written in ByteOrder.BIG_ENDIAN order. This provides complete consistency with ByteBuffer. To flip bytes to ByteOrder.LITTLE_ENDIAN order, this Bytes instance is decorated by a SwappedBytes instance which will reverse read and written bytes using, e.g. Integer.reverseBytes(int).
    
    Parameters:
    
    order - The byte order.
    
    Returns:
    
    The updated bytes.
    
    Throws:
    
    NullPointerException - If the order is null
  - isDirect
```
boolean isDirect()
```
    Returns a boolean value indicating whether the bytes are direct.
    
    Returns:
    
    Indicates whether the bytes are direct.
  - isFile
```
boolean isFile()
```
    Returns a boolean value indicating whether the bytes are backed by a file.
    
    Returns:
    
    Indicates whether the bytes are backed by a file.
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable

Interface Bytes

Field Summary

Method Summary

Methods inherited from interface io.atomix.storage.buffer.BytesInput

Methods inherited from interface io.atomix.storage.buffer.BytesOutput

Field Detail

BYTE

BOOLEAN

CHARACTER

SHORT

MEDIUM

INTEGER

LONG

FLOAT

DOUBLE

Method Detail

hasArray

array

size

resize

order

order

isDirect

isFile

close