net.openhft.chronicle.tools

Class WrappedExcerpt

java.lang.Object

net.openhft.lang.io.WrappedBytes

net.openhft.chronicle.tools.WrappedExcerpt

All Implemented Interfaces:

DataInput, DataOutput, ObjectInput, ObjectOutput, Appendable, AutoCloseable, CharSequence, RandomAccess, Excerpt, ExcerptAppender, ExcerptCommon, ExcerptTailer, MappingProvider<WrappedExcerpt>, net.openhft.lang.io.Bytes, net.openhft.lang.io.BytesCommon, net.openhft.lang.io.BytesStore, net.openhft.lang.io.ByteStringAppender, net.openhft.lang.io.ByteStringParser, net.openhft.lang.io.RandomDataInput, net.openhft.lang.io.RandomDataOutput, net.openhft.lang.io.RandomDataUpdate, net.openhft.lang.io.serialization.BytesMarshallable, net.openhft.lang.ReferenceCounted

Direct Known Subclasses:

CheckedExcerpt, WrappedExcerpts.ByteBufferBytesExcerptWrapper

public class WrappedExcerpt
extends net.openhft.lang.io.WrappedBytes
implements ExcerptTailer, ExcerptAppender, Excerpt, MappingProvider<WrappedExcerpt>

Author:

peter.lawrey

Field Summary

Fields

Modifier and Type	Field and Description
protected ExcerptAppender	wrappedAppender
protected ExcerptCommon	wrappedCommon
protected Excerpt	wrappedExcerpt
protected ExcerptTailer	wrappedTailer

Fields inherited from class net.openhft.lang.io.WrappedBytes

wrapped

Constructor Summary

Constructors

Constructor and Description
WrappedExcerpt(ExcerptCommon excerptCommon)

Method Summary

Modifier and Type	Method and Description
void	addPaddedEntry() Add a padded entry to keep the index in sync with a master source.
Chronicle	chronicle()
long	findMatch(ExcerptComparator comparator) Find any entry which return a match i.e.
void	findRange(long[] startEnd, ExcerptComparator comparator) Find entries which return a match.
long	index()
boolean	index(long index) Randomly select an Excerpt.
long	lastWrittenIndex()
boolean	nextIndex() Wind to the next entry, no matter how many padded index entries you need to skip.
long	nextSetBit(long l)
boolean	nextSynchronous() The default value is ChronicleConfig.synchronousMode()
void	nextSynchronous(boolean nextSynchronous)
boolean	read8bitText(StringBuilder builder)
protected void	setExcerpt(ExcerptCommon excerptCommon)
void	startExcerpt() Start an excerpt with the default message capacity of 128K (can be configured) This can waste up to 0.1% of disk space, unless you have sparse file support like Linux, when you will waste far less.
void	startExcerpt(long capacity) Ensure there is enough capacity for a new entry of up to the size given.
Excerpt	toEnd() Wind to the end.
Excerpt	toStart() Replay from the start.
boolean	wasPadding() Not for public use.
MappingFunction	withMapping()
WrappedExcerpt	withMapping(MappingFunction mapping)
void	write8bitText(CharSequence sequence)
void	writeEnum(long l, int i, Object o)

Methods inherited from class net.openhft.lang.io.WrappedBytes

addAndGetInt, addAtomicDouble, addAtomicFloat, addAtomicInt, addAtomicLong, addByte, addDouble, addFloat, addInt, addLong, address, addShort, addUnsignedByte, addUnsignedInt, addUnsignedShort, alignPositionAddr, append, append, append, append, append, append, append, append, append, append, append, append, appendDateMillis, appendDateTimeMillis, appendTimeMillis, asString, asString, available, busyLockInt, busyLockLong, byteOrder, bytes, bytes, capacity, charAt, checkEndOfBuffer, clear, clearThreadAssociation, close, compare, compareAndSwapDouble, compareAndSwapInt, compareAndSwapLong, file, finish, flip, flush, free, getAndAdd, inputStream, isFinished, length, limit, limit, load, objectSerializer, outputStream, parseBoolean, parseDecimal, parseDouble, parseEnum, parseLong, parseLong, parseUtf8, parseUtf8, position, position, read, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readCompactDouble, readCompactInt, readCompactLong, readCompactShort, readCompactUnsignedInt, readCompactUnsignedShort, readDouble, readDouble, readEnum, readEnum, readFloat, readFloat, readFully, readFully, readFully, readFully, readFully, readIncompleteLong, readInstance, readInt, readInt, readInt24, readInt24, readInt48, readInt48, readLine, readList, readLong, readLong, readMap, readMarshallable, readObject, readObject, readObject, readShort, readShort, readStopBit, readUnsignedByte, readUnsignedByte, readUnsignedByteOrThrow, readUnsignedInt, readUnsignedInt, readUnsignedShort, readUnsignedShort, readUTF, readUTFΔ, readUTFΔ, readUTFΔ, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileLong, refCount, release, remaining, reserve, resetLockInt, resetLockLong, selfTerminating, selfTerminating, size, skip, skipBytes, skipTo, slice, slice, sliceAsByteBuffer, startsWith, stepBackAndSkipTo, subSequence, threadIdForLockInt, threadIdForLockLong, toDebugString, toDebugString, toHexString, toString, tryLockInt, tryLockLong, tryLockNanosInt, tryLockNanosLong, tryRWReadLock, tryRWWriteLock, unlockInt, unlockLong, unlockRWReadLock, unlockRWWriteLock, write, write, write, write, write, write, write, write, write, write, write, write, writeBoolean, writeBoolean, writeByte, writeByte, writeBytes, writeChar, writeChar, writeChars, writeChars, writeCompactDouble, writeCompactInt, writeCompactLong, writeCompactShort, writeCompactUnsignedInt, writeCompactUnsignedShort, writeDouble, writeDouble, writeEnum, writeFloat, writeFloat, writeInstance, writeInt, writeInt, writeInt24, writeInt24, writeInt48, writeInt48, writeList, writeLong, writeLong, writeMap, writeMarshallable, writeObject, writeObject, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writeShort, writeShort, writeStopBit, writeUnsignedByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt, writeUnsignedShort, writeUnsignedShort, writeUTF, writeUTFΔ, writeUTFΔ, zeroOut, zeroOut, zeroOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.ExcerptCommon

finish, size

Methods inherited from interface net.openhft.lang.io.Bytes

clearThreadAssociation

Methods inherited from interface net.openhft.lang.io.RandomDataInput

available, compare, read, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readCompactDouble, readCompactInt, readCompactLong, readCompactShort, readCompactUnsignedInt, readCompactUnsignedShort, readDouble, readDouble, readEnum, readEnum, readFloat, readFloat, readFully, readFully, readFully, readFully, readFully, readIncompleteLong, readInstance, readInt, readInt, readInt24, readInt24, readInt48, readInt48, readLine, readList, readLong, readLong, readMap, readObject, readObject, readObject, readShort, readShort, readStopBit, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedShort, readUnsignedShort, readUTF, readUTFΔ, readUTFΔ, readUTFΔ, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileLong, skip, skipBytes, startsWith

Methods inherited from interface net.openhft.lang.io.RandomDataOutput

addAndGetInt, close, compareAndSwapDouble, compareAndSwapInt, compareAndSwapLong, flush, getAndAdd, write, write, write, write, write, write, write, write, write, write, write, write, writeBoolean, writeBoolean, writeByte, writeByte, writeBytes, writeChar, writeChar, writeChars, writeChars, writeCompactDouble, writeCompactInt, writeCompactLong, writeCompactShort, writeCompactUnsignedInt, writeCompactUnsignedShort, writeDouble, writeDouble, writeEnum, writeFloat, writeFloat, writeInstance, writeInt, writeInt, writeInt24, writeInt24, writeInt48, writeInt48, writeList, writeLong, writeLong, writeMap, writeObject, writeObject, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writeShort, writeShort, writeStopBit, writeUnsignedByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt, writeUnsignedShort, writeUnsignedShort, writeUTF, writeUTFΔ, writeUTFΔ, zeroOut, zeroOut, zeroOut

Methods inherited from interface net.openhft.lang.io.RandomDataUpdate

addAtomicDouble, addAtomicFloat, addAtomicInt, addAtomicLong, addByte, addDouble, addFloat, addInt, addLong, addShort, addUnsignedByte, addUnsignedInt, addUnsignedShort, busyLockInt, busyLockLong, resetLockInt, resetLockLong, threadIdForLockInt, threadIdForLockLong, tryLockInt, tryLockLong, tryLockNanosInt, tryLockNanosLong, tryRWReadLock, tryRWWriteLock, unlockInt, unlockLong, unlockRWReadLock, unlockRWWriteLock

Methods inherited from interface net.openhft.lang.io.BytesStore

address, bytes, bytes, file, free, objectSerializer

Methods inherited from interface net.openhft.lang.io.ByteStringAppender

append, append, append, append, append, append, append, append, append, append, append, append, appendDateMillis, appendDateTimeMillis, appendTimeMillis

Methods inherited from interface net.openhft.lang.io.ByteStringParser

asString, asString, parseBoolean, parseDecimal, parseDouble, parseEnum, parseLong, parseLong, parseUtf8, parseUtf8, readUnsignedByteOrThrow, selfTerminating, selfTerminating, skipTo, stepBackAndSkipTo

Methods inherited from interface net.openhft.lang.io.BytesCommon

alignPositionAddr, byteOrder, capacity, checkEndOfBuffer, clear, flip, inputStream, isFinished, limit, limit, load, objectSerializer, outputStream, position, position, remaining, slice, slice, sliceAsByteBuffer, toDebugString, toDebugString, toHexString, toString

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence, toString

Methods inherited from interface net.openhft.lang.io.serialization.BytesMarshallable

readMarshallable, writeMarshallable

Methods inherited from interface net.openhft.lang.ReferenceCounted

refCount, release, reserve

Field Detail

wrappedTailer

protected ExcerptTailer wrappedTailer

wrappedAppender

protected ExcerptAppender wrappedAppender

wrappedCommon

protected ExcerptCommon wrappedCommon

wrappedExcerpt

protected Excerpt wrappedExcerpt

Constructor Detail

WrappedExcerpt

public WrappedExcerpt(ExcerptCommon excerptCommon)

Method Detail

withMapping

public WrappedExcerpt withMapping(MappingFunction mapping)

Specified by:

withMapping in interface MappingProvider<WrappedExcerpt>

withMapping

public MappingFunction withMapping()

Specified by:

withMapping in interface MappingProvider<WrappedExcerpt>

setExcerpt

protected void setExcerpt(ExcerptCommon excerptCommon)

chronicle

public Chronicle chronicle()

Specified by:

chronicle in interface ExcerptCommon

Returns:

the chronicle associated with this Excerpt

nextIndex

public boolean nextIndex()

Description copied from interface: ExcerptTailer

Wind to the next entry, no matter how many padded index entries you need to skip. If there is padding, the index() can change even though this method might return false

Specified by:

nextIndex in interface ExcerptTailer

Returns:

Is there a valid entry to be read.

index

public boolean index(long index)
              throws IndexOutOfBoundsException

Description copied from interface: ExcerptTailer

Randomly select an Excerpt.

Specified by:

index in interface Excerpt

Specified by:

index in interface ExcerptTailer

Parameters:

index - index to look up

Returns:

true if this is a valid entries and not padding.

Throws:

IndexOutOfBoundsException

startExcerpt

public void startExcerpt()

Description copied from interface: ExcerptAppender

Start an excerpt with the default message capacity of 128K (can be configured) This can waste up to 0.1% of disk space, unless you have sparse file support like Linux, when you will waste far less.

Specified by:

startExcerpt in interface ExcerptAppender

startExcerpt

public void startExcerpt(long capacity)

Description copied from interface: ExcerptAppender

Ensure there is enough capacity for a new entry of up to the size given. If there is not enough space left in the chunk of memory mapped file, a padded entry is added and a new entry at the start of a new chunk is commenced. The capacity can be more than you need as finish() will shrink wrap the entry. It is onl a waste if you trigger a padded entry when none was required.

Specified by:

startExcerpt in interface ExcerptAppender

Parameters:

capacity - to allow for, but not exceed.

addPaddedEntry

public void addPaddedEntry()

Description copied from interface: ExcerptAppender

Add a padded entry to keep the index in sync with a master source. Not for public use. This method is expected to be retained only as a package private method in a future release.

Specified by:

addPaddedEntry in interface ExcerptAppender

nextSynchronous

public boolean nextSynchronous()

Description copied from interface: ExcerptAppender

The default value is ChronicleConfig.synchronousMode()

Specified by:

nextSynchronous in interface ExcerptAppender

Returns:

will the next write be synchronous

nextSynchronous

public void nextSynchronous(boolean nextSynchronous)

Specified by:

nextSynchronous in interface ExcerptAppender

Parameters:

nextSynchronous - make the next write synchronous or not.

index

public long index()

Specified by:

index in interface ExcerptCommon

Returns:

this appender is pointing.

lastWrittenIndex

public long lastWrittenIndex()

Specified by:

lastWrittenIndex in interface ExcerptAppender

Returns:

the index last written to including padded entries.

toStart

@NotNull
public Excerpt toStart()

Description copied from interface: ExcerptTailer

Replay from the start.

Specified by:

toStart in interface Excerpt

Specified by:

toStart in interface ExcerptTailer

Returns:

this Excerpt

toEnd

@NotNull
public Excerpt toEnd()

Description copied from interface: ExcerptTailer

Wind to the end.

Specified by:

toEnd in interface Excerpt

Specified by:

toEnd in interface ExcerptTailer

Returns:

this Excerpt

wasPadding

public boolean wasPadding()

Description copied from interface: ExcerptCommon

Not for public use. This method is expected to be retained only as a package private method in a future release.

Specified by:

wasPadding in interface ExcerptCommon

Returns:

true if the last index(long) looked up as padding.

findMatch

public long findMatch(@NotNull
                      ExcerptComparator comparator)

Description copied from interface: Excerpt

Find any entry which return a match i.e. 0, or a negative value which is the boundary between -1 and +1

Specified by:

findMatch in interface Excerpt

Parameters:

comparator - to use for comparison.

Returns:

0 to size()-1 for a match, -1 to -size()-1 for index of closest match

findRange

public void findRange(@NotNull
                      long[] startEnd,
                      @NotNull
                      ExcerptComparator comparator)

Description copied from interface: Excerpt

Find entries which return a match. This is a combined search which is usually faster than two binary search. This doesn't access the same index two. The best case is one additional comparison and the worst case is the same.

Specified by:

findRange in interface Excerpt

Parameters:

startEnd - start (inclusive) to end (enclusive). Will be equal if no exact match is found.

comparator - to use for comparison.

read8bitText

public boolean read8bitText(@NotNull
                            StringBuilder builder)
                     throws StreamCorruptedException

Specified by:

read8bitText in interface net.openhft.lang.io.RandomDataInput

Overrides:

read8bitText in class net.openhft.lang.io.WrappedBytes

Throws:

StreamCorruptedException

nextSetBit

public long nextSetBit(long l)

Specified by:

nextSetBit in interface net.openhft.lang.io.RandomDataInput

write8bitText

public void write8bitText(CharSequence sequence)

Specified by:

write8bitText in interface net.openhft.lang.io.RandomDataOutput

Overrides:

write8bitText in class net.openhft.lang.io.WrappedBytes

writeEnum

public void writeEnum(long l,
                      int i,
                      Object o)

Specified by:

writeEnum in interface net.openhft.lang.io.RandomDataOutput

Overrides:

writeEnum in class net.openhft.lang.io.WrappedBytes