net.openhft.chronicle.bytes.ref

Class AbstractReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, net.openhft.chronicle.core.io.CloseableTracer, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner

Direct Known Subclasses:

BinaryBooleanReference, BinaryIntArrayReference, BinaryIntReference, BinaryLongArrayReference, BinaryLongReference, TextBooleanReference, TextIntArrayReference, TextIntReference, TextLongArrayReference, TextLongReference

public abstract class AbstractReference
extends net.openhft.chronicle.core.io.AbstractCloseable
implements Byteable, net.openhft.chronicle.core.io.Closeable

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable BytesStore<?,?>	bytes
protected long	offset

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

CHECK_THREAD_SAFETY, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

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

INIT

Constructor Summary

Constructors

Constructor and Description
AbstractReference()

Method Summary

Modifier and Type	Method and Description
protected void	acceptNewBytesStore(@NotNull BytesStore bytes)
long	address()
@Nullable BytesStore	bytesStore()
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) This setter for a data type which points to an underlying ByteStore.
FileLock	lock(boolean shared) Calls lock on the underlying file
abstract long	maxSize()
long	offset()
protected void	performClose()
protected boolean	threadSafetyCheck(boolean isUsed)
FileLock	tryLock(boolean shared) Calls lock on the underlying file

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

assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, enableCloseableTracing, isClosed, isClosing, isInUserThread, performCloseInBackground, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

close, closeQuietly, closeQuietly, notifyClosing, warnAndCloseIfNotClosed

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

isClosed, isClosing, throwExceptionIfClosed

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

referenceName, temporary

Field Detail

bytes

@Nullable
protected @Nullable BytesStore<?,?> bytes

offset

protected long offset

Constructor Detail

AbstractReference

public AbstractReference()

Method Detail

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore bytes,
                       long offset,
                       long length)
                throws IllegalStateException,
                       IllegalArgumentException,
                       BufferOverflowException

Description copied from interface: Byteable

This setter for a data type which points to an underlying ByteStore.

Specified by:

bytesStore in interface Byteable

Parameters:

bytes - the fix point ByteStore

offset - the offset within the ByteStore

length - the length in the ByteStore

Throws:

IllegalStateException

IllegalArgumentException

BufferOverflowException

bytesStore

@Nullable
public @Nullable BytesStore bytesStore()

Specified by:

bytesStore in interface Byteable

offset

public long offset()

Specified by:

offset in interface Byteable

maxSize

public abstract long maxSize()

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in byte for this reference.

acceptNewBytesStore

protected void acceptNewBytesStore(@NotNull
                                   @NotNull BytesStore bytes)
                            throws IllegalStateException

Throws:

IllegalStateException

performClose

protected void performClose()
                     throws IllegalStateException

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

Throws:

IllegalStateException

address

public long address()
             throws IllegalStateException,
                    BufferUnderflowException

Throws:

IllegalStateException

BufferUnderflowException

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)

Overrides:

threadSafetyCheck in class net.openhft.chronicle.core.io.AbstractCloseable

lock

public FileLock lock(boolean shared)
              throws IOException

Description copied from interface: Byteable

Calls lock on the underlying file

Specified by:

lock in interface Byteable

Parameters:

shared - if the lock is shared or not.

Returns:

the FileLock

Throws:

IOException

tryLock

public FileLock tryLock(boolean shared)
                 throws IOException

Description copied from interface: Byteable

Calls lock on the underlying file

Specified by:

tryLock in interface Byteable

Parameters:

shared - if the lock is shared or not.

Returns:

the FileLock

Throws:

IOException