NoBytesStore (OpenHFT/Chronicle-Bytes 1.9.11 API)

java.lang.Object
- java.lang.Enum<NoBytesStore>
- - net.openhft.chronicle.bytes.NoBytesStore

All Implemented Interfaces:

Serializable, CharSequence, Comparable<NoBytesStore>, BytesStore, RandomDataInput, RandomDataOutput, net.openhft.chronicle.core.ReferenceCounted
```
public enum NoBytesStore
extends Enum<NoBytesStore>
implements BytesStore
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

NO_BYTES_STORE

Enum Constants
Enum Constant and Description
`NO_BYTES_STORE`

Field Summary

Fields
Modifier and Type Field and Description

static Bytes NO_BYTES

static long NO_PAGE
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString

Fields
Modifier and Type	Field and Description
`static Bytes`	`NO_BYTES`
`static long`	`NO_PAGE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default ByteOrder`	`byteOrder()`
`Bytes`	`bytesForWrite()`
`long`	`capacity()`
`default boolean`	`compareAndSwapDouble(long offset, double expected, double value)` Perform a 64-bit double CAS at a given offset.
`default boolean`	`compareAndSwapFloat(long offset, float expected, float value)` Perform a 32-bit float CAS at a given offset.
`boolean`	`compareAndSwapInt(long offset, int expected, int value)` Perform a 32-bit CAS at a given offset.
`boolean`	`compareAndSwapLong(long offset, long expected, long value)` Perform a 64-bit CAS at a given offset.
`BytesStore`	`copy()`
`long`	`copyTo(BytesStore store)` Copy the data to another BytesStore as long as there is space available in the destination store.
`boolean`	`equalBytes(BytesStore bytesStore, long length)` Check if a portion of a BytesStore matches this one.
`boolean`	`inside(long offset)` Use this test to determine if an offset is considered safe.
`boolean`	`isDirectMemory()`
`void`	`move(long from, long to, long length)`
`void`	`nativeRead(long position, long address, long size)` expert level method for copying data to native memory.
`void`	`nativeWrite(long address, long position, long size)` expert level method to copy data from native memory into the BytesStore
`static <T,B extends BytesStore<B,T>> BytesStore<B,T>`	`noBytesStore()`
`int`	`peekUnsignedByte(long offset)` Read an unsigned byte at an offset, or -1
`byte`	`readByte(long offset)` Read byte at an offset
`double`	`readDouble(long offset)` Read a double at an offset
`float`	`readFloat(long offset)` Read a float at an offset
`int`	`readInt(long offset)` Read an int at an offset
`default long`	`readLimit()`
`long`	`readLong(long offset)` Read a long at an offset
`default long`	`readPosition()` The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
`default long`	`readRemaining()`
`short`	`readShort(long offset)` Read a short at an offset
`byte`	`readVolatileByte(long offset)` Read a 8-bit byte from memory with a load barrier.
`int`	`readVolatileInt(long offset)` Read a 32-bit int from memory with a load barrier.
`long`	`readVolatileLong(long offset)` Read a 64-bit long from memory with a load barrier.
`short`	`readVolatileShort(long offset)` Read a 16-bit short from memory with a load barrier.
`long`	`refCount()`
`void`	`release()`
`void`	`reserve()`
`boolean`	`sharedMemory()`
`default long`	`start()`
`Void`	`underlyingObject()`
`static NoBytesStore`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static NoBytesStore[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`RandomDataOutput`	`write(long offsetInRDO, byte[] bytes, int offset, int length)`
`void`	`write(long offsetInRDO, ByteBuffer bytes, int offset, int length)`
`RandomDataOutput`	`write(long offsetInRDO, RandomDataInput bytes, long offset, long length)`
`RandomDataOutput`	`writeByte(long offset, byte i8)` Write an unsigned byte at an offset.
`RandomDataOutput`	`writeDouble(long offset, double d)` Write a double at an offset.
`RandomDataOutput`	`writeFloat(long offset, float d)` Write a float at an offset.
`RandomDataOutput`	`writeInt(long offset, int i)` Write an int at an offset.
`default long`	`writeLimit()`
`RandomDataOutput`	`writeLong(long offset, long i)` Write a long at an offset.
`RandomDataOutput`	`writeOrderedInt(long offset, int i)` Perform a non stalling write with a store barrier.
`RandomDataOutput`	`writeOrderedLong(long offset, long i)` Perform a non stalling write with a store barrier.
`default long`	`writePosition()` The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
`default long`	`writeRemaining()`
`RandomDataOutput`	`writeShort(long offset, short i)` Write a short at an offset.
`RandomDataOutput`	`writeVolatileByte(long offset, byte i8)`
`RandomDataOutput`	`writeVolatileInt(long offset, int i32)`
`RandomDataOutput`	`writeVolatileLong(long offset, long i64)`
`RandomDataOutput`	`writeVolatileShort(long offset, short i16)`

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, byteCheckSum, bytesForRead, bytesStore, charAt, cipher, cipher, contentEquals, copyTo, empty, endsWith, from, isClear, isEmpty, isPresent, isPresent, length, longCheckSum, nativePointer, readWrite, realCapacity, safeLimit, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxLong, zeroOut

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, peekVolatileInt, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted
release, releaseAll, tryReserve

Methods inherited from interface java.lang.CharSequence
chars, codePoints, toString

- Enum Constant Detail
  - NO_BYTES_STORE
```
public static final NoBytesStore NO_BYTES_STORE
```
- Field Detail
  - NO_PAGE
```
public static final long NO_PAGE
```
  - NO_BYTES
```
@NotNull
public static final Bytes NO_BYTES
```
- Method Detail
  - values
```
public static NoBytesStore[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (NoBytesStore c : NoBytesStore.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static NoBytesStore valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - noBytesStore
```
@NotNull
public static <T,B extends BytesStore<B,T>> BytesStore<B,T> noBytesStore()
```
  - reserve
```
public void reserve()
             throws IllegalStateException
```
    Specified by:
    
    reserve in interface net.openhft.chronicle.core.ReferenceCounted
    
    Throws:
    
    IllegalStateException
  - release
```
public void release()
             throws IllegalStateException
```
    Specified by:
    
    release in interface net.openhft.chronicle.core.ReferenceCounted
    
    Throws:
    
    IllegalStateException
  - refCount
```
public long refCount()
```
    Specified by:
    
    refCount in interface net.openhft.chronicle.core.ReferenceCounted
  - writeByte
```
@NotNull
public RandomDataOutput writeByte(long offset,
                                           byte i8)
```
    Description copied from interface: RandomDataOutput
    
    Write an unsigned byte at an offset.
    
    Specified by:
    
    writeByte in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i8 - the value
    
    Returns:
    
    this
  - writeShort
```
@NotNull
public RandomDataOutput writeShort(long offset,
                                            short i)
```
    Description copied from interface: RandomDataOutput
    
    Write a short at an offset.
    
    Specified by:
    
    writeShort in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
  - writeInt
```
@NotNull
public RandomDataOutput writeInt(long offset,
                                          int i)
```
    Description copied from interface: RandomDataOutput
    
    Write an int at an offset.
    
    Specified by:
    
    writeInt in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
  - writeOrderedInt
```
@NotNull
public RandomDataOutput writeOrderedInt(long offset,
                                                 int i)
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedInt in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
  - writeLong
```
@NotNull
public RandomDataOutput writeLong(long offset,
                                           long i)
```
    Description copied from interface: RandomDataOutput
    
    Write a long at an offset.
    
    Specified by:
    
    writeLong in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
  - writeOrderedLong
```
@NotNull
public RandomDataOutput writeOrderedLong(long offset,
                                                  long i)
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedLong in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
  - writeFloat
```
@NotNull
public RandomDataOutput writeFloat(long offset,
                                            float d)
```
    Description copied from interface: RandomDataOutput
    
    Write a float at an offset.
    
    Specified by:
    
    writeFloat in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    d - the value
    
    Returns:
    
    this
  - writeDouble
```
@NotNull
public RandomDataOutput writeDouble(long offset,
                                             double d)
```
    Description copied from interface: RandomDataOutput
    
    Write a double at an offset.
    
    Specified by:
    
    writeDouble in interface RandomDataOutput
    
    Parameters:
    
    offset - to write to
    
    d - the value
    
    Returns:
    
    this
  - writeVolatileByte
```
@NotNull
public RandomDataOutput writeVolatileByte(long offset,
                                                   byte i8)
```
    Specified by:
    
    writeVolatileByte in interface RandomDataOutput
  - writeVolatileShort
```
@NotNull
public RandomDataOutput writeVolatileShort(long offset,
                                                    short i16)
```
    Specified by:
    
    writeVolatileShort in interface RandomDataOutput
  - writeVolatileInt
```
@NotNull
public RandomDataOutput writeVolatileInt(long offset,
                                                  int i32)
```
    Specified by:
    
    writeVolatileInt in interface RandomDataOutput
  - writeVolatileLong
```
@NotNull
public RandomDataOutput writeVolatileLong(long offset,
                                                   long i64)
```
    Specified by:
    
    writeVolatileLong in interface RandomDataOutput
  - write
```
@NotNull
public RandomDataOutput write(long offsetInRDO,
                                       byte[] bytes,
                                       int offset,
                                       int length)
```
    Specified by:
    
    write in interface RandomDataOutput
  - write
```
public void write(long offsetInRDO,
                  ByteBuffer bytes,
                  int offset,
                  int length)
```
    Specified by:
    
    write in interface RandomDataOutput
  - write
```
@NotNull
public RandomDataOutput write(long offsetInRDO,
                                       RandomDataInput bytes,
                                       long offset,
                                       long length)
```
    Specified by:
    
    write in interface RandomDataOutput
  - readByte
```
public byte readByte(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read byte at an offset
    
    Specified by:
    
    readByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the byte
  - peekUnsignedByte
```
public int peekUnsignedByte(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read an unsigned byte at an offset, or -1
    
    Specified by:
    
    peekUnsignedByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the unsigned byte or -1
  - readShort
```
public short readShort(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read a short at an offset
    
    Specified by:
    
    readShort in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the short
  - readInt
```
public int readInt(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read an int at an offset
    
    Specified by:
    
    readInt in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the int
  - readLong
```
public long readLong(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read a long at an offset
    
    Specified by:
    
    readLong in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the long
  - readFloat
```
public float readFloat(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read a float at an offset
    
    Specified by:
    
    readFloat in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the float
  - readDouble
```
public double readDouble(long offset)
```
    Description copied from interface: RandomDataInput
    
    Read a double at an offset
    
    Specified by:
    
    readDouble in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the double
  - readVolatileByte
```
public byte readVolatileByte(long offset)
                      throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 8-bit byte from memory with a load barrier.
    
    Specified by:
    
    readVolatileByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the byte value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileShort
```
public short readVolatileShort(long offset)
                        throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 16-bit short from memory with a load barrier.
    
    Specified by:
    
    readVolatileShort in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the short value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileInt
```
public int readVolatileInt(long offset)
                    throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 32-bit int from memory with a load barrier.
    
    Specified by:
    
    readVolatileInt in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the int value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileLong
```
public long readVolatileLong(long offset)
                      throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 64-bit long from memory with a load barrier.
    
    Specified by:
    
    readVolatileLong in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the long value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - isDirectMemory
```
public boolean isDirectMemory()
```
    Specified by:
    
    isDirectMemory in interface BytesStore
    
    Returns:
    
    whether it uses direct memory or not.
  - copy
```
@NotNull
public BytesStore copy()
```
    Specified by:
    
    copy in interface BytesStore
    
    Returns:
    
    a copy of this BytesStore.
  - capacity
```
public long capacity()
```
    Specified by:
    
    capacity in interface BytesStore
    
    Returns:
    
    The maximum limit you can set.
  - underlyingObject
```
public Void underlyingObject()
```
    Specified by:
    
    underlyingObject in interface BytesStore
    
    Returns:
    
    the underlying object being wrapped, if there is one, or null if not.
  - inside
```
public boolean inside(long offset)
```
    Description copied from interface: BytesStore
    
    Use this test to determine if an offset is considered safe.
    
    Specified by:
    
    inside in interface BytesStore
  - copyTo
```
public long copyTo(BytesStore store)
```
    Description copied from interface: BytesStore
    
    Copy the data to another BytesStore as long as there is space available in the destination store.
    
    Specified by:
    
    copyTo in interface BytesStore
    
    Parameters:
    
    store - to copy to
    
    Returns:
    
    how many bytes were copied
  - nativeWrite
```
public void nativeWrite(long address,
                        long position,
                        long size)
```
    Description copied from interface: RandomDataOutput
    
    expert level method to copy data from native memory into the BytesStore
    
    Specified by:
    
    nativeWrite in interface RandomDataOutput
    
    Parameters:
    
    address - in native memory to copy from
    
    position - in BytesStore to copy to
    
    size - in bytes
  - nativeRead
```
public void nativeRead(long position,
                       long address,
                       long size)
```
    Description copied from interface: RandomDataInput
    
    expert level method for copying data to native memory.
    
    Specified by:
    
    nativeRead in interface RandomDataInput
    
    Parameters:
    
    position - within the ByteStore to copy.
    
    address - in native memory
    
    size - in bytes
  - compareAndSwapInt
```
public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
```
    Perform a 32-bit CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
  - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
```
    Perform a 64-bit CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
  - equalBytes
```
public boolean equalBytes(BytesStore bytesStore,
                          long length)
```
    Description copied from interface: BytesStore
    
    Check if a portion of a BytesStore matches this one.
    
    Specified by:
    
    equalBytes in interface BytesStore
    
    Parameters:
    
    bytesStore - to match against
    
    length - to match.
    
    Returns:
    
    true if the bytes and length matched.
  - move
```
public void move(long from,
                 long to,
                 long length)
```
    Specified by:
    
    move in interface BytesStore
  - address
```
public long address(long offset)
             throws BufferOverflowException
```
    Obtain the underlying address. This is for expert users only.
    
    Parameters:
    
    offset - within this buffer. address(start()) is the actual address of the first byte.
    
    Returns:
    
    the underlying address of the buffer
    
    Throws:
    
    BufferOverflowException
  - bytesForWrite
```
@NotNull
public Bytes bytesForWrite()
```
    Specified by:
    
    bytesForWrite in interface BytesStore
    
    Returns:
    
    a Bytes for writing to this BytesStore
  - sharedMemory
```
public boolean sharedMemory()
```
    Returns:
    
    true if these Bytes use shared memory.
  - start
```
public long start()
```
    Returns:
    
    The smallest position allowed in this buffer.
  - readPosition
```
public long readPosition()
```
    The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
    
    Returns:
    
    position to read from.
  - writePosition
```
public long writePosition()
```
    The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
    
    Returns:
    
    position to write to.
  - readRemaining
```
public long readRemaining()
```
    Returns:
    
    How many more bytes can we read.
  - writeRemaining
```
public long writeRemaining()
```
    Returns:
    
    How many more bytes can we written.
  - readLimit
```
public long readLimit()
```
    Returns:
    
    the highest offset or position allowed for this buffer.
  - writeLimit
```
public long writeLimit()
```
  - byteOrder
```
public ByteOrder byteOrder()
```
  - compareAndSwapFloat
```
public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException,
                                   IllegalArgumentException
```
    Perform a 32-bit float CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException
    
    IllegalArgumentException
  - compareAndSwapDouble
```
public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException,
                                    IllegalArgumentException
```
    Perform a 64-bit double CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException
    
    IllegalArgumentException

Enum NoBytesStore

Enum Constant Summary

Field Summary

Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

Methods inherited from interface java.lang.CharSequence

Enum Constant Detail

NO_BYTES_STORE

Field Detail

NO_PAGE

NO_BYTES

Method Detail

values

valueOf

noBytesStore

reserve

release

refCount

writeByte

writeShort

writeInt

writeOrderedInt

writeLong

writeOrderedLong

writeFloat

writeDouble

writeVolatileByte

writeVolatileShort

writeVolatileInt

writeVolatileLong

write

write

write

readByte

peekUnsignedByte

readShort

readInt

readLong

readFloat

readDouble

readVolatileByte

readVolatileShort

readVolatileInt

readVolatileLong

isDirectMemory

copy

capacity

underlyingObject

inside

copyTo

nativeWrite

nativeRead

compareAndSwapInt

compareAndSwapLong

equalBytes

move

address

bytesForWrite

sharedMemory

start

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

byteOrder

compareAndSwapFloat

compareAndSwapDouble