NativeBytesStore (OpenHFT/Chronicle-Bytes 2.24ea1 API)

java.lang.Object
- net.openhft.chronicle.core.io.AbstractReferenceCounted
- - net.openhft.chronicle.bytes.internal.AbstractBytesStore<NativeBytesStore,U>
 - - net.openhft.chronicle.bytes.internal.NativeBytesStore

All Implemented Interfaces:

CharSequence, BytesStore<NativeBytesStore,U>, RandomDataInput, RandomDataOutput<NativeBytesStore>, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

Direct Known Subclasses:

MappedBytesStore, PointerBytesStore
```
public class NativeBytesStore
extends AbstractBytesStore<NativeBytesStore,U>
```

Field Summary

Fields
Modifier and Type Field and Description

long address

protected long limit

long maximumLimit

net.openhft.chronicle.core.Memory memory
- Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted
  referenceCounted, WARN_COUNT, WARN_NS
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString
- Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
  INIT, TMP
- Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked
  DISABLE_SINGLE_THREADED_CHECK

Fields
Modifier and Type	Field and Description
`long`	`address`
`protected long`	`limit`
`long`	`maximumLimit`
`net.openhft.chronicle.core.Memory`	`memory`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`NativeBytesStore(@NotNull ByteBuffer bb, boolean elastic, int maximumLimit)`
	`NativeBytesStore(long address, long limit)`
	`NativeBytesStore(long address, long limit, @Nullable Runnable deallocator, boolean elastic)`
`protected`	`NativeBytesStore(long address, long limit, @Nullable Runnable deallocator, boolean elastic, boolean monitored)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`int`	`addAndGetInt(long offset, int adding)` Perform an atomic add and get operation for a 32-bit int
`long`	`addAndGetLong(long offset, long adding)` Perform an atomic add and get operation for a 64-bit long
`long`	`addressForRead(long offset)` Obtain the underlying addressForRead.
`default long`	`addressForRead(long offset, int buffer)`
`long`	`addressForWrite(long offset)` Obtain the underlying addressForRead.
`long`	`addressForWritePosition()`
`long`	`appendUtf8(long pos, char[] chars, int offset, int length)`
`protected void`	`backgroundPerformRelease()`
`int`	`byteCheckSum()` Returns the bytes sum of the readable bytes in this BytesStore.
`int`	`byteCheckSum(long position, long limit)` Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).
`default ByteOrder`	`byteOrder()`
`@NotNull VanillaBytes<U>`	`bytesForWrite()` Returns a Bytes that wraps this ByteStore from the `start` to the `realCapacity`.
`boolean`	`canReadDirect(long length)`
`long`	`capacity()`
`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.
`@NotNull BytesStore<NativeBytesStore<U>,U>`	`copy()`
`long`	`copyTo(@NotNull BytesStore store)` Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.
`long`	`copyToDirect(@NotNull BytesStore store)`
`static @NotNull NativeBytesStore<ByteBuffer>`	`elasticByteBuffer()`
`static @NotNull NativeBytesStore<ByteBuffer>`	`elasticByteBuffer(int size, long maxSize)`
`boolean`	`equals(Object obj)`
`int`	`fastHash(long offset, int length)`
`static @NotNull NativeBytesStore`	`from(byte[] bytes)`
`static @NotNull NativeBytesStore`	`from(@NotNull String text)` Returns a BytesStore using the bytes in a String.
`int`	`hashCode()`
`void`	`init(@NotNull ByteBuffer bb, boolean elastic)`
`boolean`	`isDirectMemory()`
`boolean`	`isEqual(long start, long length, String s)` Returns if a specified portion of this BytesStore is equal to a specified String.
`static @NotNull NativeBytesStore<Void>`	`lazyNativeBytesStoreWithFixedCapacity(long capacity)`
`default long`	`lengthWritten(long startPosition)` Typically this calculates the difference however for HexDumpBytes it's not as simple.
`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.
`static @NotNull NativeBytesStore<Void>`	`nativeStore(long capacity)` this is an elastic native store
`static @NotNull NativeBytesStore<Void>`	`nativeStoreWithFixedCapacity(long capacity)`
`void`	`nativeWrite(long address, long position, long size)` expert level method to copy data from native memory into the BytesStore
`int`	`peekUnsignedByte(long offset)` Read an unsigned byte at an offset, or -1
`protected void`	`performRelease()`
`long`	`read(long offsetInRDI, byte[] bytes, int offset, int length)`
`void`	`read8bit(long position, char[] chars, int length)`
`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
`long`	`readIncompleteLong(long offset)` Read a long which is zero padded (high bytes) if the available bytes is less than 8.
`int`	`readInt(long offset)` Read an int at an offset
`default long`	`readLimit()` If the resource is closed, the returned value is unspecified.
`long`	`readLong(long offset)` Read a long at an offset
`short`	`readShort(long offset)` Read a short at an offset
`int`	`readUnsignedByte(long offset)` Read an unsigned byte 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`	`realCapacity()` Returns the actual capacity that can be potentially read.
`default long`	`realReadRemaining()` If the resource is closed, the returned value is unspecified.
`default long`	`realWriteRemaining()` If the resource is closed, the returned value is unspecified.
`long`	`safeLimit()`
`void`	`setAddress(long address)`
`boolean`	`sharedMemory()`
`void`	`testAndSetInt(long offset, int expected, int value)`
`@NotNull String`	`toString()`
`@NotNull ByteBuffer`	`toTemporaryDirectByteBuffer()`
`long`	`translate(long offset)`
`U`	`underlyingObject()`
`void`	`uninit()`
`static <T> @NotNull NativeBytesStore<T>`	`uninitialized()`
`static @NotNull NativeBytesStore<ByteBuffer>`	`wrap(@NotNull ByteBuffer bb)` Wraps a ByteBuffer which can be either on heap or off heap.
`@NotNull NativeBytesStore<U>`	`write(long offsetInRDO, byte[] byteArray, int offset, int length)` Copies the provided `byteArray` to this Bytes object starting at `writeOffset` taking content starting at `readOffset` but copying at most `length` bytes.
`void`	`write(long offsetInRDO, @NotNull ByteBuffer bytes, int offset, int length)` Copy from ByteBuffer into this.
`@NotNull NativeBytesStore<U>`	`write(long writeOffset, @NotNull RandomDataInput bytes, long readOffset, long length)` Copy from RandomDataInput into this.
`void`	`write0(long offsetInRDO, @NotNull RandomDataInput bytes, long offset, long length)`
`long`	`write8bit(long position, @NotNull BytesStore bs)` Write the stop bit length and copy the BytesStore
`long`	`write8bit(long position, @NotNull String s, int start, int length)`
`@NotNull NativeBytesStore<U>`	`writeByte(long offset, byte i8)` Write an unsigned byte at an offset.
`@NotNull NativeBytesStore<U>`	`writeDouble(long offset, double d)` Write a double at an offset.
`@NotNull NativeBytesStore<U>`	`writeFloat(long offset, float f)` Write a float at an offset.
`@NotNull NativeBytesStore<U>`	`writeInt(long offset, int i32)` Write an int at an offset.
`default long`	`writeLimit()` Returns the write limit.
`@NotNull NativeBytesStore<U>`	`writeLong(long offset, long i64)` Write a long at an offset.
`@NotNull NativeBytesStore<U>`	`writeOrderedInt(long offset, int i)` Perform a non stalling write with a store barrier.
`@NotNull NativeBytesStore<U>`	`writeOrderedLong(long offset, long i)` Perform a non stalling write with a store barrier.
`default long`	`writePosition()` Returns the write position.
`@NotNull NativeBytesStore<U>`	`writeShort(long offset, short i16)` Write a short at an offset.
`@NotNull NativeBytesStore<U>`	`writeVolatileByte(long offset, byte i8)`
`@NotNull NativeBytesStore<U>`	`writeVolatileInt(long offset, int i32)`
`@NotNull NativeBytesStore<U>`	`writeVolatileLong(long offset, long i64)`
`@NotNull NativeBytesStore<U>`	`writeVolatileShort(long offset, short i16)`
`@NotNull NativeBytesStore<U>`	`zeroOut(long start, long end)` Fills the BytesStore with zeros.

Methods inherited from class net.openhft.chronicle.bytes.internal.AbstractBytesStore
canReleaseInBackground, readPosition, readRemaining, start, writeRemaining

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted
addReferenceChangeListener, assertReferencesReleased, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceId, release, releaseLast, removeReferenceChangeListener, reserve, reservedBy, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, tryReserve, unmonitor, warnAndReleaseIfNotReleased

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

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, bytesForRead, bytesStore, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, copyTo, empty, endsWith, equalBytes, forFields, from, from, hash, inside, inside, isClear, isEmpty, isImmutableEmptyByteStore, length, nativePointer, nativeStoreFrom, readWrite, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, writeMaxInt, writeMaxLong

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, findByte, parseLong, peekVolatileInt, printable, readBoolean, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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.io.ReferenceCounted
addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reservedBy, reserveTransfer, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
referenceId, referenceName, temporary

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

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCountedTracer
onReleased

- Field Detail
 - address
```
public long address
```
 - memory
```
public net.openhft.chronicle.core.Memory memory
```
 - maximumLimit
```
public long maximumLimit
```
 - limit
```
protected long limit
```
- Constructor Detail
 - NativeBytesStore
```
public NativeBytesStore(@NotNull
 @NotNull ByteBuffer bb,
 boolean elastic,
 int maximumLimit)
```
 - NativeBytesStore
```
public NativeBytesStore(long address,
 long limit)
```
 - NativeBytesStore
```
public NativeBytesStore(long address,
 long limit,
 @Nullable
 @Nullable Runnable deallocator,
 boolean elastic)
```
 - NativeBytesStore
```
protected NativeBytesStore(long address,
 long limit,
 @Nullable
 @Nullable Runnable deallocator,
 boolean elastic,
 boolean monitored)
```
- Method Detail
 - wrap
```
@NotNull
public static @NotNull NativeBytesStore<ByteBuffer> wrap(@NotNull
 @NotNull ByteBuffer bb)
```
 Description copied from interface: BytesStore
 
 Wraps a ByteBuffer which can be either on heap or off heap.
 When resulting BytesStore instance is closed, direct byteBuffer will be deallocated and should no longer be used.
 
 Parameters:
 
 bb - ByteBuffer
 
 Returns:
 
 BytesStore
 - uninitialized
```
@NotNull
public static <T> @NotNull NativeBytesStore<T> uninitialized()
```
 - nativeStore
```
@NotNull
public static @NotNull NativeBytesStore<Void> nativeStore(long capacity)
 throws IllegalArgumentException
```
 this is an elastic native store
 
 Parameters:
 
 capacity - of the buffer.
 
 Throws:
 
 IllegalArgumentException
 - nativeStoreWithFixedCapacity
```
@NotNull
public static @NotNull NativeBytesStore<Void> nativeStoreWithFixedCapacity(long capacity)
 throws IllegalArgumentException
```
 Throws:
 
 IllegalArgumentException
 - lazyNativeBytesStoreWithFixedCapacity
```
@NotNull
public static @NotNull NativeBytesStore<Void> lazyNativeBytesStoreWithFixedCapacity(long capacity)
 throws IllegalArgumentException
```
 Throws:
 
 IllegalArgumentException
 - elasticByteBuffer
```
@NotNull
public static @NotNull NativeBytesStore<ByteBuffer> elasticByteBuffer()
```
 - elasticByteBuffer
```
@NotNull
public static @NotNull NativeBytesStore<ByteBuffer> elasticByteBuffer(int size,
 long maxSize)
```
 - from
```
@NotNull
public static @NotNull NativeBytesStore from(@NotNull
 @NotNull String text)
```
 Description copied from interface: BytesStore
 
 Returns a BytesStore using the bytes in a String. The characters in the String are encoded using ISO_8859_1
 
 Parameters:
 
 text - a String
 
 Returns:
 
 BytesStore
 - from
```
@NotNull
public static @NotNull NativeBytesStore from(byte[] bytes)
```
 - isDirectMemory
```
public boolean isDirectMemory()
```
 Returns:
 
 whether it uses direct memory or not.
 - canReadDirect
```
public boolean canReadDirect(long length)
```
 - init
```
public void init(@NotNull
 @NotNull ByteBuffer bb,
 boolean elastic)
```
 - uninit
```
public void uninit()
```
 - move
```
public void move(long from,
 long to,
 long length)
 throws BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 BufferUnderflowException
 
 IllegalStateException
 - copy
```
@NotNull
public @NotNull BytesStore<NativeBytesStore,U> copy()
 throws IllegalStateException
```
 Returns:
 
 a copy of this BytesStore.
 
 Throws:
 
 IllegalStateException
 - bytesForWrite
```
@NotNull
public @NotNull VanillaBytes bytesForWrite()
 throws IllegalStateException
```
 Description copied from interface: BytesStore
 
 Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
 The returned Bytes is not elastic and can be both read and written using cursors.
 
 Returns:
 
 a Bytes that wraps this BytesStore
 
 Throws:
 
 IllegalStateException - if this BytesStore has been released
 - realCapacity
```
public long realCapacity()
```
 Description copied from interface: RandomDataInput
 
 Returns the actual capacity that can be potentially read.
 
 Returns:
 
 the actual capacity available before resizing
 - capacity
```
public long capacity()
```
 Returns:
 
 The maximum limit you can set.
 - underlyingObject
```
@Nullable
public U underlyingObject()
```
 Returns:
 
 the underlying object being wrapped, if there is one, or null if not.
 - zeroOut
```
@NotNull
public @NotNull NativeBytesStore zeroOut(long start,
 long end)
```
 Description copied from interface: BytesStore
 
 Fills the BytesStore with zeros.
 
 Parameters:
 
 start - first byte inclusive
 
 end - last byte exclusive
 
 Returns:
 
 this
 - compareAndSwapInt
```
public boolean compareAndSwapInt(long offset,
 int expected,
 int value)
 throws IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 32-bit CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 IllegalStateException
 - testAndSetInt
```
public void testAndSetInt(long offset,
 int expected,
 int value)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
 long expected,
 long value)
 throws IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 64-bit CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 IllegalStateException
 - addAndGetLong
```
public long addAndGetLong(long offset,
 long adding)
 throws BufferUnderflowException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 64-bit long
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - if the offset is outside the limits of the Bytes
 - addAndGetInt
```
public int addAndGetInt(long offset,
 int adding)
 throws BufferUnderflowException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 32-bit int
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - if the offset is outside the limits of the Bytes
 - translate
```
public long translate(long offset)
```
 - readByte
```
public byte readByte(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read byte at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the byte
 - readUnsignedByte
```
public int readUnsignedByte(long offset)
 throws BufferUnderflowException
```
 Description copied from interface: RandomDataInput
 
 Read an unsigned byte at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the unsigned byte
 
 Throws:
 
 BufferUnderflowException - if the offset is outside the limits of the Bytes
 - readShort
```
public short readShort(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a short at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the short
 - readInt
```
public int readInt(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read an int at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the int
 - readLong
```
public long readLong(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a long at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the long
 - readFloat
```
public float readFloat(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a float at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the float
 - readDouble
```
public double readDouble(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a double at an offset
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the double
 - readVolatileByte
```
public byte readVolatileByte(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a 8-bit byte from memory with a load barrier.
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the byte value
 - readVolatileShort
```
public short readVolatileShort(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a 16-bit short from memory with a load barrier.
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the short value
 - readVolatileInt
```
public int readVolatileInt(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a 32-bit int from memory with a load barrier.
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the int value
 - readVolatileLong
```
public long readVolatileLong(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a 64-bit long from memory with a load barrier.
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the long value
 - writeByte
```
@NotNull
public @NotNull NativeBytesStore writeByte(long offset,
 byte i8)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write an unsigned byte at an offset.
 
 Parameters:
 
 offset - to write to
 
 i8 - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeShort
```
@NotNull
public @NotNull NativeBytesStore writeShort(long offset,
 short i16)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write a short at an offset.
 
 Parameters:
 
 offset - to write to
 
 i16 - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeInt
```
@NotNull
public @NotNull NativeBytesStore writeInt(long offset,
 int i32)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write an int at an offset.
 
 Parameters:
 
 offset - to write to
 
 i32 - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeOrderedInt
```
@NotNull
public @NotNull NativeBytesStore writeOrderedInt(long offset,
 int i)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Perform a non stalling write with a store barrier.
 
 Parameters:
 
 offset - to write to
 
 i - value to write
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeLong
```
@NotNull
public @NotNull NativeBytesStore writeLong(long offset,
 long i64)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write a long at an offset.
 
 Parameters:
 
 offset - to write to
 
 i64 - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeOrderedLong
```
@NotNull
public @NotNull NativeBytesStore writeOrderedLong(long offset,
 long i)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Perform a non stalling write with a store barrier.
 
 Parameters:
 
 offset - to write to
 
 i - value to write
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeFloat
```
@NotNull
public @NotNull NativeBytesStore writeFloat(long offset,
 float f)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write a float at an offset.
 
 Parameters:
 
 offset - to write to
 
 f - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeDouble
```
@NotNull
public @NotNull NativeBytesStore writeDouble(long offset,
 double d)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Write a double at an offset.
 
 Parameters:
 
 offset - to write to
 
 d - the value
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - writeVolatileByte
```
@NotNull
public @NotNull NativeBytesStore writeVolatileByte(long offset,
 byte i8)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - writeVolatileShort
```
@NotNull
public @NotNull NativeBytesStore writeVolatileShort(long offset,
 short i16)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - writeVolatileInt
```
@NotNull
public @NotNull NativeBytesStore writeVolatileInt(long offset,
 int i32)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - writeVolatileLong
```
@NotNull
public @NotNull NativeBytesStore writeVolatileLong(long offset,
 long i64)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - write
```
@NotNull
public @NotNull NativeBytesStore write(long offsetInRDO,
 byte[] byteArray,
 int offset,
 int length)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.
 Does not update cursors e.g. writePosition()
 
 Parameters:
 
 offsetInRDO - non-negative offset to write to
 
 byteArray - non-null copy from byteArray
 
 offset - non-negative copy from offset
 
 length - non-negative length to copy
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException - if this Bytes object has been previously released
 - write
```
public void write(long offsetInRDO,
 @NotNull
 @NotNull ByteBuffer bytes,
 int offset,
 int length)
 throws IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Copy from ByteBuffer into this.
 Does not update cursors e.g. writePosition()
 
 Parameters:
 
 offsetInRDO - offset to write to
 
 bytes - copy from bytes
 
 offset - copy from offset
 
 Throws:
 
 IllegalStateException
 - write
```
@NotNull
public @NotNull NativeBytesStore write(long writeOffset,
 @NotNull
 @NotNull RandomDataInput bytes,
 long readOffset,
 long length)
 throws BufferOverflowException,
 BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 Copy from RandomDataInput into this. Does not bump writePosition() nor RandomCommon.readPosition()
 
 Parameters:
 
 writeOffset - offset to write to
 
 bytes - copy from bytes
 
 readOffset - copy from offset
 
 Returns:
 
 this
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 
 BufferUnderflowException
 - write0
```
public void write0(long offsetInRDO,
 @NotNull
 @NotNull RandomDataInput bytes,
 long offset,
 long length)
 throws BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 BufferUnderflowException
 
 IllegalStateException
 - addressForRead
```
public long addressForRead(long offset)
 throws BufferUnderflowException
```
 Obtain the underlying addressForRead. This is for expert users only.
 
 Parameters:
 
 offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.
 
 Returns:
 
 the underlying addressForRead of the buffer
 
 Throws:
 
 BufferUnderflowException - if the offset is before the start() or the after the capacity()
 - addressForWrite
```
public long addressForWrite(long offset)
 throws BufferOverflowException
```
 Obtain the underlying addressForRead. This is for expert users only.
 
 Parameters:
 
 offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.
 
 Returns:
 
 the underlying addressForRead of the buffer
 
 Throws:
 
 BufferOverflowException - if the offset is before the start() or the after the capacity()
 - addressForWritePosition
```
public long addressForWritePosition()
 throws UnsupportedOperationException,
 BufferOverflowException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferOverflowException
 - backgroundPerformRelease
```
protected void backgroundPerformRelease()
```
 Overrides:
 
 backgroundPerformRelease in class net.openhft.chronicle.core.io.AbstractReferenceCounted
 - performRelease
```
protected void performRelease()
```
 Specified by:
 
 performRelease in class net.openhft.chronicle.core.io.AbstractReferenceCounted
 - toString
```
@NotNull
public @NotNull String toString()
```
 Specified by:
 
 toString in interface CharSequence
 
 Overrides:
 
 toString in class net.openhft.chronicle.core.io.AbstractReferenceCounted
 - nativeRead
```
public void nativeRead(long position,
 long address,
 long size)
 throws BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 expert level method for copying data to native memory.
 
 Parameters:
 
 position - within the ByteStore to copy.
 
 address - in native memory
 
 size - in bytes
 
 Throws:
 
 BufferUnderflowException - if the offset is outside the limits of the Bytes
 
 IllegalStateException - if released
 - nativeWrite
```
public void nativeWrite(long address,
 long position,
 long size)
 throws BufferOverflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataOutput
 
 expert level method to copy data from native memory into the BytesStore
 
 Parameters:
 
 address - in native memory to copy from
 
 position - in BytesStore to copy to
 
 size - in bytes
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - write8bit
```
public long write8bit(long position,
 @NotNull
 @NotNull BytesStore bs)
```
 Description copied from interface: RandomDataOutput
 
 Write the stop bit length and copy the BytesStore
 
 Parameters:
 
 position - to write
 
 bs - to copy.
 
 Returns:
 
 the offset after the char sequence written, in this RandomDataOutput
 - write8bit
```
public long write8bit(long position,
 @NotNull
 @NotNull String s,
 int start,
 int length)
```
 - read8bit
```
public void read8bit(long position,
 char[] chars,
 int length)
```
 - readIncompleteLong
```
public long readIncompleteLong(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a long which is zero padded (high bytes) if the available bytes is less than 8. If the offset is at or beyond the readLimit, this will return 0L.
 
 Parameters:
 
 offset - to read from
 
 Returns:
 
 the long which might be padded.
 - setAddress
```
public void setAddress(long address)
```
 - appendUtf8
```
public long appendUtf8(long pos,
 char[] chars,
 int offset,
 int length)
 throws BufferOverflowException,
 IllegalStateException
```
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - copyTo
```
public long copyTo(@NotNull
 @NotNull BytesStore store)
 throws IllegalStateException
```
 Description copied from interface: BytesStore
 
 Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.
 Copies the data to another BytesStore as long as space is available in the destination BytesStore.
 
 Parameters:
 
 store - the BytesStore to copy to
 
 Returns:
 
 how many bytes were copied
 
 Throws:
 
 IllegalStateException - if this BytesStore has been released
 - copyToDirect
```
public long copyToDirect(@NotNull
 @NotNull BytesStore store)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - toTemporaryDirectByteBuffer
```
@NotNull
public @NotNull ByteBuffer toTemporaryDirectByteBuffer()
```
 - byteCheckSum
```
public int byteCheckSum()
 throws net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: BytesStore
 
 Returns the bytes sum of the readable bytes in this BytesStore.
 
 Returns:
 
 unsigned bytes sum
 
 Throws:
 
 net.openhft.chronicle.core.io.IORuntimeException
 - byteCheckSum
```
public int byteCheckSum(long position,
 long limit)
```
 Description copied from interface: BytesStore
 
 Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).
 
 Parameters:
 
 position - the index of the first byte to sum
 
 limit - the index of the last byte to sum
 
 Returns:
 
 unsigned bytes sum
 - sharedMemory
```
public boolean sharedMemory()
```
 Returns:
 
 true if these Bytes use shared memory.
 - read
```
public long read(long offsetInRDI,
 byte[] bytes,
 int offset,
 int length)
```
 - 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
 
 Overrides:
 
 peekUnsignedByte in class AbstractBytesStore<NativeBytesStore,U>
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the unsigned byte or -1
 - fastHash
```
public int fastHash(long offset,
 int length)
 throws BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 BufferUnderflowException
 
 IllegalStateException
 - safeLimit
```
public long safeLimit()
```
 Returns:
 
 how many bytes can be safely read, i.e. what is the real capacity of the underlying data.
 - isEqual
```
public boolean isEqual(long start,
 long length,
 String s)
```
 Description copied from interface: BytesStore
 
 Returns if a specified portion of this BytesStore is equal to a specified String. The portion is specified with its offset and length.
 
 Parameters:
 
 start - the portion offset
 
 length - the number of bytes from this BytesStore that should be compared to s
 
 s - the String to compare to
 
 Returns:
 
 true if the specified portion of this BytesStore is equal to s
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class AbstractBytesStore<NativeBytesStore,U>
 - equals
```
public boolean equals(Object obj)
```
 Overrides:
 
 equals in class AbstractBytesStore<NativeBytesStore,U>
 - writePosition
```
public long writePosition()
```
 Returns the write position.
 The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 position to write to.
 - lengthWritten
```
public long lengthWritten(long startPosition)
```
 Typically this calculates the difference however for HexDumpBytes it's not as simple.
 If the resource is closed, the returned value is unspecified.
 
 Parameters:
 
 startPosition - to compare against
 
 Returns:
 
 the length from the startPosition
 - realReadRemaining
```
public long realReadRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 how much can be safely read directly.
 - realWriteRemaining
```
public long realWriteRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 writeRemaining with resize
 - readLimit
```
public long readLimit()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 the highest offset or position allowed for this buffer.
 - writeLimit
```
public long writeLimit()
```
 Returns the write limit.
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 the write limit
 - addressForRead
```
public long addressForRead(long offset,
 int buffer)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferUnderflowException
 
 IllegalStateException
 - byteOrder
```
public ByteOrder byteOrder()
```

Class NativeBytesStore<U>

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

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

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

Constructor Summary

Method Summary

Methods inherited from class net.openhft.chronicle.bytes.internal.AbstractBytesStore

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

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.io.ReferenceCounted

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

Methods inherited from interface java.lang.CharSequence

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

Field Detail

address

memory

maximumLimit

limit

Constructor Detail

NativeBytesStore

NativeBytesStore

NativeBytesStore

NativeBytesStore

Method Detail

wrap

uninitialized

nativeStore

nativeStoreWithFixedCapacity

lazyNativeBytesStoreWithFixedCapacity

elasticByteBuffer

elasticByteBuffer

from

from

isDirectMemory

canReadDirect

init

uninit

move

copy

bytesForWrite

realCapacity

capacity

underlyingObject

zeroOut

compareAndSwapInt

testAndSetInt

compareAndSwapLong

addAndGetLong

addAndGetInt

translate

readByte

readUnsignedByte

readShort

readInt

readLong

readFloat

readDouble

readVolatileByte

readVolatileShort

readVolatileInt

readVolatileLong

writeByte

writeShort

writeInt

writeOrderedInt

writeLong

writeOrderedLong

writeFloat

writeDouble

writeVolatileByte

writeVolatileShort

writeVolatileInt

writeVolatileLong

write

write