HeapBytesStore (OpenHFT/Chronicle-Bytes 1.0.18-beta API)

java.lang.Object
- net.openhft.chronicle.bytes.HeapBytesStore<Underlying>

All Implemented Interfaces:

Closeable, AutoCloseable, CharSequence, BytesStore<HeapBytesStore<Underlying>,Underlying>, RandomDataInput, RandomDataOutput<HeapBytesStore<Underlying>>, net.openhft.chronicle.core.ReferenceCounted
```
public class HeapBytesStore<Underlying>
extends Object
implements BytesStore<HeapBytesStore<Underlying>,Underlying>
```

Field Summary
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default ByteOrder`	`byteOrder()`
`long`	`capacity()`
`boolean`	`compareAndSwapInt(long offset, int expected, int value)`
`boolean`	`compareAndSwapLong(long offset, long expected, long value)`
`BytesStore<HeapBytesStore<Underlying>,Underlying>`	`copy()`
`boolean`	`equals(Object obj)`
`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
`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()`
`String`	`toString()`
`Underlying`	`underlyingObject()`
`HeapBytesStore<Underlying>`	`write(long offsetInRDO, byte[] bytes, int offset, int length)`
`void`	`write(long offsetInRDO, ByteBuffer bytes, int offset, int length)`
`HeapBytesStore<Underlying>`	`write(long offsetInRDO, RandomDataInput bytes, long offset, long length)`
`HeapBytesStore<Underlying>`	`writeByte(long offset, byte b)`
`HeapBytesStore<Underlying>`	`writeDouble(long offset, double d)`
`HeapBytesStore<Underlying>`	`writeFloat(long offset, float f)`
`HeapBytesStore`	`writeInt(long offset, int i32)`
`default long`	`writeLimit()`
`HeapBytesStore<Underlying>`	`writeLong(long offset, long i64)`
`HeapBytesStore<Underlying>`	`writeOrderedInt(long offset, int i32)`
`HeapBytesStore<Underlying>`	`writeOrderedLong(long offset, long i)`
`default long`	`writePosition()`
`default long`	`writeRemaining()`
`HeapBytesStore<Underlying>`	`writeShort(long offset, short i16)`

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

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetInt, addAndGetLong, byteCheckSum, bytesForRead, bytesForWrite, bytesStore, charAt, copyTo, equalBytes, getAndAddInt, inside, isClear, length, nativePointer, realCapacity, safeLimit, subSequence, toDebugString, 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

- Method Detail
  - toString
```
@NotNull
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - copy
```
@NotNull
public BytesStore<HeapBytesStore<Underlying>,Underlying> copy()
```
    Specified by:
    
    copy in interface BytesStore<HeapBytesStore<Underlying>,Underlying>
    
    Returns:
    
    a copy of this BytesStore.
  - reserve
```
public void reserve()
```
    Specified by:
    
    reserve in interface net.openhft.chronicle.core.ReferenceCounted
  - release
```
public void release()
```
    Specified by:
    
    release in interface net.openhft.chronicle.core.ReferenceCounted
  - refCount
```
public long refCount()
```
    Specified by:
    
    refCount in interface net.openhft.chronicle.core.ReferenceCounted
  - capacity
```
public long capacity()
```
    Specified by:
    
    capacity in interface BytesStore<HeapBytesStore<Underlying>,Underlying>
    
    Returns:
    
    The maximum limit you can set.
  - underlyingObject
```
@NotNull
public Underlying underlyingObject()
```
    Specified by:
    
    underlyingObject in interface BytesStore<HeapBytesStore<Underlying>,Underlying>
  - compareAndSwapInt
```
public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
```
    Specified by:
    
    compareAndSwapInt in interface BytesStore<HeapBytesStore<Underlying>,Underlying>
  - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
```
    Specified by:
    
    compareAndSwapLong in interface BytesStore<HeapBytesStore<Underlying>,Underlying>
  - 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
  - writeByte
```
@NotNull
public HeapBytesStore<Underlying> writeByte(long offset,
                                                     byte b)
```
    Specified by:
    
    writeByte in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeShort
```
@NotNull
public HeapBytesStore<Underlying> writeShort(long offset,
                                                      short i16)
```
    Specified by:
    
    writeShort in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeInt
```
@NotNull
public HeapBytesStore writeInt(long offset,
                                        int i32)
```
    Specified by:
    
    writeInt in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeOrderedInt
```
@NotNull
public HeapBytesStore<Underlying> writeOrderedInt(long offset,
                                                           int i32)
```
    Specified by:
    
    writeOrderedInt in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeLong
```
@NotNull
public HeapBytesStore<Underlying> writeLong(long offset,
                                                     long i64)
```
    Specified by:
    
    writeLong in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeOrderedLong
```
@NotNull
public HeapBytesStore<Underlying> writeOrderedLong(long offset,
                                                            long i)
```
    Specified by:
    
    writeOrderedLong in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeFloat
```
@NotNull
public HeapBytesStore<Underlying> writeFloat(long offset,
                                                      float f)
```
    Specified by:
    
    writeFloat in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - writeDouble
```
@NotNull
public HeapBytesStore<Underlying> writeDouble(long offset,
                                                       double d)
```
    Specified by:
    
    writeDouble in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - write
```
@NotNull
public HeapBytesStore<Underlying> write(long offsetInRDO,
                                                 byte[] bytes,
                                                 int offset,
                                                 int length)
```
    Specified by:
    
    write in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - write
```
public void write(long offsetInRDO,
                  @NotNull
                  ByteBuffer bytes,
                  int offset,
                  int length)
```
    Specified by:
    
    write in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - write
```
@NotNull
public HeapBytesStore<Underlying> write(long offsetInRDO,
                                                 RandomDataInput bytes,
                                                 long offset,
                                                 long length)
```
    Specified by:
    
    write in interface RandomDataOutput<HeapBytesStore<Underlying>>
  - 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
  - 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
  - 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<HeapBytesStore<Underlying>>
    
    Parameters:
    
    address - in native memory to copy from
    
    position - in BytesStore to copy to
    
    size - in bytes
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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()
```

Class HeapBytesStore<Underlying>

Field Summary

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

Method Summary

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 net.openhft.chronicle.core.io.Closeable

Methods inherited from interface java.lang.CharSequence

Method Detail

toString

copy

reserve

release

refCount

capacity

underlyingObject

compareAndSwapInt

compareAndSwapLong

readByte

readShort

readInt

readLong

readFloat

readDouble

writeByte

writeShort

writeInt

writeOrderedInt

writeLong

writeOrderedLong

writeFloat

writeDouble

write

write

write

address

nativeRead

nativeWrite

equals

start

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

byteOrder