net.openhft.chronicle.bytes

Enum NoBytesStore

java.lang.Object

java.lang.Enum<NoBytesStore>

net.openhft.chronicle.bytes.NoBytesStore

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, 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

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

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default ByteOrder	byteOrder()
Bytes	bytesForWrite()
long	capacity()
boolean	compareAndSwapInt(long offset, int expected, int value)
boolean	compareAndSwapLong(long offset, long expected, long value)
BytesStore	copy()
void	copyTo(BytesStore store)
boolean	equalBytes(BytesStore b, long remaining)
boolean	inside(long offset) Use this test to determine if an offset is considered safe.
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()
byte	readByte(long offset)
double	readDouble(long offset)
float	readFloat(long offset)
int	readInt(long offset)
default long	readLimit()
long	readLong(long offset)
default long	readPosition()
default long	readRemaining()
short	readShort(long offset)
long	refCount()
void	release()
void	reserve()
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)
RandomDataOutput	writeDouble(long offset, double d)
RandomDataOutput	writeFloat(long offset, float d)
RandomDataOutput	writeInt(long offset, int i)
default long	writeLimit()
RandomDataOutput	writeLong(long offset, long i)
RandomDataOutput	writeOrderedInt(long offset, int i)
RandomDataOutput	writeOrderedLong(long offset, long i)
default long	writePosition()
default long	writeRemaining()
RandomDataOutput	writeShort(long offset, short i)

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, toString, wait, wait, wait

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

addAndGetInt, addAndGetLong, byteCheckSum, bytesForRead, bytesStore, charAt, getAndAddInt, isClear, length, nativePointer, realCapacity, safeLimit, subSequence, toDebugString, wrap, wrap, zeroOut

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

bytesEqual, copyTo, createCharToString, parseLong, printable, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedShort, readVolatileInt, readVolatileLong

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

append, write, write, writeBoolean, writeByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort

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

close, release, releaseAll, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly

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

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)

Specified by:

writeByte in interface RandomDataOutput

writeShort

@NotNull
public RandomDataOutput writeShort(long offset,
                                            short i)

Specified by:

writeShort in interface RandomDataOutput

writeInt

@NotNull
public RandomDataOutput writeInt(long offset,
                                          int i)

Specified by:

writeInt in interface RandomDataOutput

writeOrderedInt

@NotNull
public RandomDataOutput writeOrderedInt(long offset,
                                                 int i)

Specified by:

writeOrderedInt in interface RandomDataOutput

writeLong

@NotNull
public RandomDataOutput writeLong(long offset,
                                           long i)

Specified by:

writeLong in interface RandomDataOutput

writeOrderedLong

@NotNull
public RandomDataOutput writeOrderedLong(long offset,
                                                  long i)

Specified by:

writeOrderedLong in interface RandomDataOutput

writeFloat

@NotNull
public RandomDataOutput writeFloat(long offset,
                                            float d)

Specified by:

writeFloat in interface RandomDataOutput

writeDouble

@NotNull
public RandomDataOutput writeDouble(long offset,
                                             double d)

Specified by:

writeDouble 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)

Specified by:

readByte in interface RandomDataInput

readShort

public short readShort(long offset)

Specified by:

readShort in interface RandomDataInput

readInt

public int readInt(long offset)

Specified by:

readInt in interface RandomDataInput

readLong

public long readLong(long offset)

Specified by:

readLong in interface RandomDataInput

readFloat

public float readFloat(long offset)

Specified by:

readFloat in interface RandomDataInput

readDouble

public double readDouble(long offset)

Specified by:

readDouble in interface RandomDataInput

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

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 void copyTo(BytesStore store)

Specified by:

copyTo in interface BytesStore

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)

Specified by:

compareAndSwapInt in interface BytesStore

compareAndSwapLong

public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)

Specified by:

compareAndSwapLong in interface BytesStore

equalBytes

public boolean equalBytes(BytesStore b,
                          long remaining)

Specified by:

equalBytes in interface BytesStore

address

public long address(long offset)
             throws UnsupportedOperationException

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:

UnsupportedOperationException - if the underlying buffer is on the heap

bytesForWrite

@NotNull
public Bytes bytesForWrite()

Specified by:

bytesForWrite in interface BytesStore

Returns:

the streaming bytes for writing.

start

public long start()

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

writePosition

public long writePosition()

readRemaining

public long readRemaining()

writeRemaining

public long writeRemaining()

readLimit

public long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

byteOrder

public ByteOrder byteOrder()