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

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

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable, CharSequence, Bytes<Underlying>, BytesStore<Bytes<Underlying>,Underlying>, ByteStringAppender<Bytes<Underlying>>, RandomDataInput, RandomDataOutput<Bytes<Underlying>>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted

Direct Known Subclasses:

MappedBytes, UncheckedBytes, VanillaBytes
```
public abstract class AbstractBytes<Underlying>
extends Object
implements Bytes<Underlying>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected BytesStore<Bytes<Underlying>,Underlying>`	`bytesStore`
`protected long`	`readPosition`
`protected long`	`writeLimit`
`protected long`	`writePosition`

Fields inherited from interface net.openhft.chronicle.bytes.Bytes
MAX_CAPACITY

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()`
`BytesStore`	`bytesStore()`
`long`	`capacity()`
`Bytes<Underlying>`	`clear()`
`boolean`	`compareAndSwapInt(long offset, int expected, int value)`
`boolean`	`compareAndSwapLong(long offset, long expected, long value)`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBytes(Bytes b2, long remaining)`
`int`	`hashCode()`
`void`	`nativeRead(long address, long size)` This is an expert level method for copying raw native memory in bulk.
`void`	`nativeRead(long position, long address, long size)` expert level method for copying data to native memory.
`void`	`nativeWrite(long address, long size)` This is an expert level method for writing out data to native memory.
`void`	`nativeWrite(long address, long position, long size)` expert level method to copy data from native memory into the BytesStore
`default void`	`parse8bit(Appendable sb, StopCharsTester stopCharsTester)`
`default double`	`parseDouble()`
`default long`	`parseLong()`
`default void`	`parseUTF(Appendable sb, StopCharsTester stopCharsTester)`
`default void`	`parseUTF(Appendable sb, StopCharTester stopCharTester)`
`default String`	`parseUTF(StopCharTester stopCharTester)`
`int`	`peekUnsignedByte()`
`byte`	`readByte()`
`byte`	`readByte(long offset)`
`double`	`readDouble()`
`double`	`readDouble(long offset)`
`float`	`readFloat()`
`float`	`readFloat(long offset)`
`int`	`readInt()`
`int`	`readInt(long offset)`
`long`	`readLimit()`
`Bytes<Underlying>`	`readLimit(long limit)`
`long`	`readLong()`
`long`	`readLong(long offset)`
`protected long`	`readOffsetPositionMoved(long adding)`
`long`	`readPosition()`
`Bytes<Underlying>`	`readPosition(long position)`
`default long`	`readRemaining()`
`short`	`readShort()`
`short`	`readShort(long offset)`
`Bytes<Underlying>`	`readSkip(long bytesToSkip)`
`int`	`readVolatileInt()`
`long`	`readVolatileLong()`
`long`	`realCapacity()`
`long`	`refCount()`
`void`	`release()`
`void`	`reserve()`
`default boolean`	`skipTo(StopCharTester tester)`
`long`	`start()`
`String`	`toString()`
`Underlying`	`underlyingObject()`
`Bytes<Underlying>`	`write(byte[] bytes, int offset, int length)`
`Bytes<Underlying>`	`write(ByteBuffer buffer)`
`Bytes<Underlying>`	`write(long offsetInRDO, byte[] bytes, int offset, int length)`
`void`	`write(long offsetInRDO, ByteBuffer bytes, int offset, int length)`
`Bytes<Underlying>`	`write(long offsetInRDO, RandomDataInput bytes, long offset, long length)`
`Bytes<Underlying>`	`writeByte(byte i8)`
`Bytes<Underlying>`	`writeByte(long offset, byte i)`
`Bytes<Underlying>`	`writeDouble(double d)`
`Bytes<Underlying>`	`writeDouble(long offset, double d)`
`Bytes<Underlying>`	`writeFloat(float f)`
`Bytes<Underlying>`	`writeFloat(long offset, float d)`
`Bytes<Underlying>`	`writeInt(int i)`
`Bytes<Underlying>`	`writeInt(long offset, int i)`
`long`	`writeLimit()`
`Bytes<Underlying>`	`writeLimit(long limit)`
`Bytes<Underlying>`	`writeLong(long i64)`
`Bytes<Underlying>`	`writeLong(long offset, long i)`
`protected long`	`writeOffsetPositionMoved(long adding)`
`Bytes<Underlying>`	`writeOrderedInt(int i)`
`Bytes<Underlying>`	`writeOrderedInt(long offset, int i)`
`Bytes<Underlying>`	`writeOrderedLong(long i)`
`Bytes<Underlying>`	`writeOrderedLong(long offset, long i)`
`long`	`writePosition()`
`Bytes<Underlying>`	`writePosition(long position)`
`default long`	`writeRemaining()`
`Bytes<Underlying>`	`writeShort(long offset, short i)`
`Bytes<Underlying>`	`writeShort(short i16)`
`Bytes<Underlying>`	`writeSkip(long bytesToSkip)`

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

Methods inherited from interface net.openhft.chronicle.bytes.Bytes
allocateDirect, allocateElasticDirect, allocateElasticDirect, bytesForRead, copy, elasticByteBuffer, ensureCapacity, expect, expect, from, isClear, isElastic, safeLimit, toHexString, toHexString, toString, toString, unchecked, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetInt, addAndGetLong, byteCheckSum, bytesForWrite, charAt, copyTo, equalBytes, getAndAddInt, inside, length, nativePointer, 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 java.lang.CharSequence
chars, codePoints

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataInput
inputStream, parseWithLength, read, read, readBoolean, readStopBit, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTFΔ, readUTFΔ, readWithLength

Methods inherited from interface net.openhft.chronicle.bytes.ByteStringAppender
append, append, append, append, append, append, append, append8bit, appendDateMillis, appendTimeMillis

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
outputStream, write, write, write, writeBoolean, writeStopBit, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUTFΔ

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

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

- Field Detail
  - bytesStore
```
@Nullable
protected BytesStore<Bytes<Underlying>,Underlying> bytesStore
```
  - readPosition
```
protected long readPosition
```
  - writePosition
```
protected long writePosition
```
  - writeLimit
```
protected long writeLimit
```
- Method Detail
  - clear
```
@NotNull
public Bytes<Underlying> clear()
```
  - readLimit
```
public long readLimit()
```
    Returns:
    
    the highest offset or position allowed for this buffer.
  - writeLimit
```
public long writeLimit()
```
  - realCapacity
```
public long realCapacity()
```
    Specified by:
    
    realCapacity in interface Bytes<Underlying>
    
    Specified by:
    
    realCapacity in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Specified by:
    
    realCapacity in interface RandomDataInput
    
    Returns:
    
    the actual capacity available before resizing.
  - capacity
```
public long capacity()
```
    Specified by:
    
    capacity in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    The maximum limit you can set.
  - underlyingObject
```
@Nullable
public Underlying underlyingObject()
```
    Specified by:
    
    underlyingObject in interface BytesStore<Bytes<Underlying>,Underlying>
  - start
```
public long start()
```
    Returns:
    
    The smallest position allowed in this buffer.
  - readPosition
```
public long readPosition()
```
  - writePosition
```
public long writePosition()
```
  - compareAndSwapInt
```
public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
```
    Specified by:
    
    compareAndSwapInt in interface BytesStore<Bytes<Underlying>,Underlying>
  - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
```
    Specified by:
    
    compareAndSwapLong in interface BytesStore<Bytes<Underlying>,Underlying>
  - readPosition
```
public Bytes<Underlying> readPosition(long position)
```
    Specified by:
    
    readPosition in interface StreamingDataInput<Bytes<Underlying>>
  - readLimit
```
public Bytes<Underlying> readLimit(long limit)
```
    Specified by:
    
    readLimit in interface StreamingDataInput<Bytes<Underlying>>
  - writePosition
```
public Bytes<Underlying> writePosition(long position)
```
    Specified by:
    
    writePosition in interface StreamingDataOutput<Bytes<Underlying>>
  - readSkip
```
public Bytes<Underlying> readSkip(long bytesToSkip)
```
  - writeSkip
```
public Bytes<Underlying> writeSkip(long bytesToSkip)
```
  - writeLimit
```
public Bytes<Underlying> writeLimit(long limit)
```
    Specified by:
    
    writeLimit in interface StreamingDataOutput<Bytes<Underlying>>
  - readByte
```
public byte readByte()
```
    Specified by:
    
    readByte in interface StreamingDataInput<Bytes<Underlying>>
  - peekUnsignedByte
```
public int peekUnsignedByte()
```
    Specified by:
    
    peekUnsignedByte in interface StreamingDataInput<Bytes<Underlying>>
  - readShort
```
public short readShort()
```
    Specified by:
    
    readShort in interface StreamingDataInput<Bytes<Underlying>>
  - readInt
```
public int readInt()
```
    Specified by:
    
    readInt in interface StreamingDataInput<Bytes<Underlying>>
  - readLong
```
public long readLong()
```
    Specified by:
    
    readLong in interface StreamingDataInput<Bytes<Underlying>>
  - readFloat
```
public float readFloat()
```
    Specified by:
    
    readFloat in interface StreamingDataInput<Bytes<Underlying>>
  - readDouble
```
public double readDouble()
```
    Specified by:
    
    readDouble in interface StreamingDataInput<Bytes<Underlying>>
  - readVolatileInt
```
public int readVolatileInt()
```
    Specified by:
    
    readVolatileInt in interface StreamingDataInput<Bytes<Underlying>>
  - readVolatileLong
```
public long readVolatileLong()
```
    Specified by:
    
    readVolatileLong in interface StreamingDataInput<Bytes<Underlying>>
  - readOffsetPositionMoved
```
protected long readOffsetPositionMoved(long adding)
```
  - 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
  - writeByte
```
@NotNull
public Bytes<Underlying> writeByte(long offset,
                                            byte i)
```
    Specified by:
    
    writeByte in interface RandomDataOutput<Bytes<Underlying>>
  - writeShort
```
@NotNull
public Bytes<Underlying> writeShort(long offset,
                                             short i)
```
    Specified by:
    
    writeShort in interface RandomDataOutput<Bytes<Underlying>>
  - writeInt
```
@NotNull
public Bytes<Underlying> writeInt(long offset,
                                           int i)
```
    Specified by:
    
    writeInt in interface RandomDataOutput<Bytes<Underlying>>
  - writeOrderedInt
```
@NotNull
public Bytes<Underlying> writeOrderedInt(long offset,
                                                  int i)
```
    Specified by:
    
    writeOrderedInt in interface RandomDataOutput<Bytes<Underlying>>
  - writeLong
```
@NotNull
public Bytes<Underlying> writeLong(long offset,
                                            long i)
```
    Specified by:
    
    writeLong in interface RandomDataOutput<Bytes<Underlying>>
  - writeOrderedLong
```
@NotNull
public Bytes<Underlying> writeOrderedLong(long offset,
                                                   long i)
```
    Specified by:
    
    writeOrderedLong in interface RandomDataOutput<Bytes<Underlying>>
  - writeFloat
```
@NotNull
public Bytes<Underlying> writeFloat(long offset,
                                             float d)
```
    Specified by:
    
    writeFloat in interface RandomDataOutput<Bytes<Underlying>>
  - writeDouble
```
@NotNull
public Bytes<Underlying> writeDouble(long offset,
                                              double d)
```
    Specified by:
    
    writeDouble in interface RandomDataOutput<Bytes<Underlying>>
  - write
```
@NotNull
public Bytes<Underlying> write(long offsetInRDO,
                                        byte[] bytes,
                                        int offset,
                                        int length)
```
    Specified by:
    
    write in interface RandomDataOutput<Bytes<Underlying>>
  - write
```
public void write(long offsetInRDO,
                  ByteBuffer bytes,
                  int offset,
                  int length)
```
    Specified by:
    
    write in interface RandomDataOutput<Bytes<Underlying>>
  - write
```
@NotNull
public Bytes<Underlying> write(long offsetInRDO,
                                        RandomDataInput bytes,
                                        long offset,
                                        long length)
```
    Specified by:
    
    write in interface RandomDataOutput<Bytes<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 Bytes<Underlying> writeByte(byte i8)
```
    Specified by:
    
    writeByte in interface StreamingDataOutput<Bytes<Underlying>>
  - writeOffsetPositionMoved
```
protected long writeOffsetPositionMoved(long adding)
```
  - writeShort
```
@NotNull
public Bytes<Underlying> writeShort(short i16)
```
    Specified by:
    
    writeShort in interface StreamingDataOutput<Bytes<Underlying>>
  - writeInt
```
@NotNull
public Bytes<Underlying> writeInt(int i)
```
    Specified by:
    
    writeInt in interface StreamingDataOutput<Bytes<Underlying>>
  - writeLong
```
@NotNull
public Bytes<Underlying> writeLong(long i64)
```
    Specified by:
    
    writeLong in interface StreamingDataOutput<Bytes<Underlying>>
  - writeFloat
```
@NotNull
public Bytes<Underlying> writeFloat(float f)
```
    Specified by:
    
    writeFloat in interface StreamingDataOutput<Bytes<Underlying>>
  - writeDouble
```
@NotNull
public Bytes<Underlying> writeDouble(double d)
```
    Specified by:
    
    writeDouble in interface StreamingDataOutput<Bytes<Underlying>>
  - write
```
@NotNull
public Bytes<Underlying> write(byte[] bytes,
                                        int offset,
                                        int length)
```
    Specified by:
    
    write in interface StreamingDataOutput<Bytes<Underlying>>
  - write
```
@NotNull
public Bytes<Underlying> write(@NotNull
                                        ByteBuffer buffer)
```
    Specified by:
    
    write in interface StreamingDataOutput<Bytes<Underlying>>
  - writeOrderedInt
```
@NotNull
public Bytes<Underlying> writeOrderedInt(int i)
```
    Specified by:
    
    writeOrderedInt in interface StreamingDataOutput<Bytes<Underlying>>
  - writeOrderedLong
```
@NotNull
public Bytes<Underlying> writeOrderedLong(long i)
```
    Specified by:
    
    writeOrderedLong in interface StreamingDataOutput<Bytes<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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBytes
```
public boolean equalsBytes(@NotNull
                           Bytes b2,
                           long remaining)
```
  - toString
```
@NotNull
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - nativeRead
```
public void nativeRead(long address,
                       long size)
```
    Description copied from interface: StreamingDataInput
    
    This is an expert level method for copying raw native memory in bulk.
    
    Specified by:
    
    nativeRead in interface StreamingDataInput<Bytes<Underlying>>
    
    Parameters:
    
    address - of the memory.
    
    size - in bytes.
  - nativeWrite
```
public void nativeWrite(long address,
                        long size)
```
    Description copied from interface: StreamingDataOutput
    
    This is an expert level method for writing out data to native memory.
    
    Specified by:
    
    nativeWrite in interface StreamingDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    address - to write 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
  - 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<Bytes<Underlying>>
    
    Parameters:
    
    address - in native memory to copy from
    
    position - in BytesStore to copy to
    
    size - in bytes
  - bytesStore
```
@Nullable
public BytesStore bytesStore()
```
    Specified by:
    
    bytesStore in interface BytesStore<Bytes<Underlying>,Underlying>
  - parseUTF
```
@NotNull
public String parseUTF(@NotNull
                                StopCharTester stopCharTester)
```
  - parseUTF
```
public void parseUTF(@NotNull
                     Appendable sb,
                     @NotNull
                     StopCharTester stopCharTester)
```
  - parseUTF
```
public void parseUTF(@NotNull
                     Appendable sb,
                     @NotNull
                     StopCharsTester stopCharsTester)
```
  - parse8bit
```
public void parse8bit(Appendable sb,
                      @NotNull
                      StopCharsTester stopCharsTester)
```
  - parseLong
```
public long parseLong()
```
  - parseDouble
```
public double parseDouble()
```
  - skipTo
```
public boolean skipTo(@NotNull
                      StopCharTester tester)
```
  - readRemaining
```
public long readRemaining()
```
  - writeRemaining
```
public long writeRemaining()
```
  - byteOrder
```
public ByteOrder byteOrder()
```

Class AbstractBytes<Underlying>

Field Summary

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

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.Bytes

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 java.lang.CharSequence

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

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

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

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

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

Field Detail

bytesStore

readPosition

writePosition

writeLimit

Method Detail

clear

readLimit

writeLimit

realCapacity

capacity

underlyingObject

start

readPosition

writePosition

compareAndSwapInt

compareAndSwapLong

readPosition

readLimit

writePosition

readSkip

writeSkip

writeLimit

readByte

peekUnsignedByte

readShort

readInt

readLong

readFloat

readDouble

readVolatileInt

readVolatileLong

readOffsetPositionMoved

reserve

release

refCount

writeByte

writeShort

writeInt

writeOrderedInt

writeLong

writeOrderedLong

writeFloat

writeDouble

write

write

write

readByte

readShort

readInt

readLong

readFloat

readDouble

writeByte

writeOffsetPositionMoved

writeShort

writeInt

writeLong

writeFloat

writeDouble

write

write

writeOrderedInt

writeOrderedLong