net.openhft.chronicle

Interface Excerpt

All Superinterfaces:

Appendable, AutoCloseable, net.openhft.lang.io.Bytes, net.openhft.lang.io.BytesCommon, net.openhft.lang.io.serialization.BytesMarshallable, net.openhft.lang.io.ByteStringAppender, net.openhft.lang.io.ByteStringParser, CharSequence, DataInput, DataOutput, ExcerptCommon, ExcerptTailer, ObjectInput, ObjectOutput, RandomAccess, net.openhft.lang.io.RandomDataInput, net.openhft.lang.io.RandomDataOutput, net.openhft.lang.io.RandomDataUpdate

All Known Implementing Classes:

NativeExcerpt, WrappedExcerpt

public interface Excerpt
extends ExcerptTailer

Author:

peter.lawrey

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	index(long l) Randomly select an Excerpt.
Excerpt	toEnd() Wind to the end.
Excerpt	toStart() Replay from the start.

Methods inherited from interface net.openhft.chronicle.ExcerptTailer

nextIndex

Methods inherited from interface net.openhft.chronicle.ExcerptCommon

chronicle, finish, index, lastWrittenIndex, size, wasPadding

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

available, close, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readCompactDouble, readCompactInt, readCompactLong, readCompactShort, readCompactUnsignedInt, readCompactUnsignedShort, readDouble, readDouble, readEnum, readFloat, readFloat, readFully, readFully, 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

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

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

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

addAtomicDouble, addAtomicFloat, addAtomicInt, addAtomicLong, addByte, addDouble, addFloat, addInt, addLong, addShort, addUnsignedByte, addUnsignedInt, addUnsignedShort, busyLockInt, busyLockLong, tryLockInt, tryLockLong, tryLockNanosInt, tryLockNanosLong, unlockInt, unlockLong

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

parseBoolean, parseDecimal, parseDouble, parseEnum, parseLong, parseLong, parseUTF, parseUTF, skipTo, stepBackAndSkipTo

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

byteOrder, bytesMarshallerFactory, capacity, checkEndOfBuffer, inputStream, isFinished, outputStream, position, position, remaining, reset, write

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence, toString

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

readMarshallable, writeMarshallable

Method Detail

findMatch

long findMatch(@NotNull
             ExcerptComparator comparator)

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

Parameters:

comparator - to use for comparison.

Returns:

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

findRange

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

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.

Parameters:

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

comparator - to use for comparison.

index

boolean index(long l)

Randomly select an Excerpt.

Specified by:

index in interface ExcerptTailer

Parameters:

l - index to look up

Returns:

true if this is a valid entries and not padding.

toStart

@NotNull
Excerpt toStart()

Replay from the start.

Specified by:

toStart in interface ExcerptTailer

Returns:

this Excerpt

toEnd

@NotNull
Excerpt toEnd()

Wind to the end.

Specified by:

toEnd in interface ExcerptCommon

Specified by:

toEnd in interface ExcerptTailer

Returns:

this Excerpt