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

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

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

DISABLE_SINGLE_THREADED_CHECK

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) Retrieves the underlying memory address for reading.
default long	addressForRead(long offset, int buffer) Retrieves the underlying memory address for reading.
long	addressForWrite(long offset) Retrieves the underlying memory address for writing.
long	addressForWritePosition() Retrieves the underlying memory address for writing at the current write position.
default ByteOrder	byteOrder() Retrieves the byte order used by the buffer.
protected boolean	canReleaseInBackground()
boolean	equals(Object obj)
int	hashCode()
byte[]	internalNumberBuffer() Deprecated.
default long	lengthWritten(long startPosition) Calculates the length of data written from the given start position.
int	peekUnsignedByte(long offset) Reads an unsigned byte value from a specific offset.
default long	readLimit() If the resource is closed, the returned value is unspecified.
long	readPosition() Returns the read position.
long	readRemaining() Calculates the number of bytes remaining that can be read from the current read position.
default long	realReadRemaining() Calculates the number of bytes that can be safely read directly.
default long	realWriteRemaining() Calculates the number of bytes remaining that can be written from the current write position with resizing.
boolean	sharedMemory() Checks if the Bytes use shared memory.
long	start()
default long	writeLimit() Retrieves the maximum writable position within the buffer.
default long	writePosition() Returns the write position.
long	writeRemaining() Calculates the number of bytes remaining that can be written from the current write position.

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

addReferenceChangeListener, assertReferencesReleased, backgroundPerformRelease, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, referenceCountedUnmonitored, referenceId, release, releaseLast, removeReferenceChangeListener, 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, follow, 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, appendAndReturnLength, 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

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

Reads an unsigned byte value from a specific offset. Returns -1 if the byte read is at the end of the byte source. The value is returned as an int in order to represent the unsigned byte as a positive value.

Specified by:

peekUnsignedByte in interface RandomDataInput

Parameters:

offset - the location from where the unsigned byte value is read.

Returns:

the unsigned byte value interpreted as a positive int or -1.

Throws:

IllegalStateException - if the byte source has been 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()

Calculates the number of bytes remaining that can be read from the current read position.

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

Returns:

The number of bytes that can still be read.

writeRemaining

public long writeRemaining()

Calculates the number of bytes remaining that can be written from the current write position.

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

Returns:

The number of bytes that can still be 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

internalNumberBuffer

@Deprecated
public byte[] internalNumberBuffer()

Deprecated.

Specified by:

internalNumberBuffer in interface RandomDataOutput<B extends BytesStore<B,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)

Calculates the length of data written from the given start position.

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 - The position to calculate the length from.

Returns:

The length of data written from the given start position.

realReadRemaining

public long realReadRemaining()

Calculates the number of bytes that can be safely read directly.

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

Returns:

The number of bytes that can be safely read directly.

realWriteRemaining

public long realWriteRemaining()

Calculates the number of bytes remaining that can be written from the current write position with resizing.

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

Returns:

The number of bytes that can still be written with resizing.

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

Retrieves the maximum writable position within the buffer.

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

Returns:

the write limit

addressForRead

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

Retrieves the underlying memory address for reading. 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 - if the buffer has been closed.

addressForRead

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

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - The offset within this buffer.

buffer - The buffer index.

Returns:

The underlying memory address for reading at the specified offset.

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap.

BufferUnderflowException - if the offset is before the start or after the capacity.

IllegalStateException - if the buffer has been closed.

addressForWrite

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

Retrieves the underlying memory address for writing. 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

Retrieves the underlying memory address for writing at the current write position. This is for expert users only.

Returns:

The underlying memory address for writing at the current write position.

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap.

BufferOverflowException - if the current write position is before the start or after the capacity.

IllegalStateException - if the buffer state doesn't allow the operation.

byteOrder

public ByteOrder byteOrder()

Retrieves the byte order used by the buffer.

Returns:

The byte order used by the buffer.

sharedMemory

public boolean sharedMemory()

Checks if the Bytes use shared memory.

Returns:

True if the Bytes use shared memory, false otherwise.