net.openhft.chronicle.bytes.internal

Class AbstractBytesStore<B extends BytesStore<B,U>,U>

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.bytes.internal.AbstractBytesStore<B,U>

Type Parameters:

B - ByteStore type

U - Underlying type

All Implemented Interfaces:

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

Direct Known Subclasses:

HeapBytesStore, NativeBytesStore

public abstract class AbstractBytesStore<B extends BytesStore<B,U>,U>
extends net.openhft.chronicle.core.io.AbstractReferenceCounted
implements BytesStore<B,U>

Abstract BytesStore

Field Summary

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBytesStore()
protected	AbstractBytesStore(boolean monitored)

Method Summary

Modifier and Type	Method and Description
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()
default ByteOrder	byteOrder()
protected boolean	canReleaseInBackground()
boolean	equals(Object obj)
int	hashCode()
default long	lengthWritten(long startPosition) Typically this calculates the difference however for HexDumpBytes it's not as simple.
int	peekUnsignedByte(long offset) Read an unsigned byte at an offset, or -1
default long	readLimit() If the resource is closed, the returned value is unspecified.
long	readPosition() Returns the read position.
long	readRemaining() Returns the remaining bytes that can be 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.
boolean	sharedMemory()
long	start()
default long	writeLimit() Returns the write limit.
default long	writePosition() Returns the write position.
long	writeRemaining() If the resource is closed, the returned value is unspecified.

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

assertReferencesReleased, backgroundPerformRelease, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, referenceId, release, releaseLast, reserve, reservedBy, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, toString, 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, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, byteCheckSum, byteCheckSum, bytesForRead, bytesForWrite, bytesStore, capacity, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, compareAndSwapInt, compareAndSwapLong, contentEquals, copy, copyTo, copyTo, elasticByteBuffer, empty, endsWith, equalBytes, forFields, from, from, from, hash, inside, inside, isClear, isDirectMemory, isEmpty, isEqual, isImmutableEmptyByteStore, lazyNativeBytesStoreWithFixedCapacity, length, move, nativePointer, nativeStore, nativeStoreFrom, nativeStoreWithFixedCapacity, readWrite, realCapacity, safeLimit, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, underlyingObject, wrap, wrap, wrap, writeMaxInt, writeMaxLong, zeroOut

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

canReadDirect, canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, nativeRead, parseLong, peekVolatileInt, printable, read, readBoolean, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, testAndSetInt, toByteArray, toTemporaryDirectByteBuffer

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

append, append, nativeWrite, testAndSetInt, write, write, write, write, write, write8bit, write8bit, writeBoolean, writeByte, writeByte, writeDouble, writeFloat, writeInt, writeInt24, writeLong, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedLong, writeShort, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileByte, writeVolatileDouble, writeVolatileFloat, writeVolatileInt, writeVolatileLong, writeVolatileShort

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

refCount, release, releaseLast, releaseLast, 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, toString

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

onReleased

Constructor Detail

AbstractBytesStore

protected AbstractBytesStore()

AbstractBytesStore

protected AbstractBytesStore(boolean monitored)

Method Detail

peekUnsignedByte

public int peekUnsignedByte(long offset)
                     throws IllegalStateException

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

Throws:

IllegalStateException - if released

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

readPosition

public long readPosition()

Returns the read position.

The read position is start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to read from.

readRemaining

public long readRemaining()

Returns the remaining bytes that can be read.

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we read.

writeRemaining

public long writeRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we written.

start

public long start()

Returns:

The smallest position allowed in this buffer.

canReleaseInBackground

protected boolean canReleaseInBackground()

Overrides:

canReleaseInBackground in class net.openhft.chronicle.core.io.AbstractReferenceCounted

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)
                    throws UnsupportedOperationException,
                           BufferUnderflowException,
                           IllegalStateException

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:

UnsupportedOperationException - if the underlying buffer is on the heap

BufferUnderflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException,
                           IllegalStateException

Throws:

UnsupportedOperationException

BufferUnderflowException

IllegalStateException

addressForWrite

public long addressForWrite(long offset)
                     throws UnsupportedOperationException,
                            BufferOverflowException,
                            IllegalStateException

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:

UnsupportedOperationException - if the underlying buffer is on the heap

BufferOverflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForWritePosition

public long addressForWritePosition()
                             throws UnsupportedOperationException,
                                    BufferOverflowException,
                                    IllegalStateException

Throws:

UnsupportedOperationException

BufferOverflowException

IllegalStateException

byteOrder

public ByteOrder byteOrder()

sharedMemory

public boolean sharedMemory()

Returns:

true if these Bytes use shared memory.