RecordBuffer (QD Core API 3.346)

java.lang.Object
- com.devexperts.qd.ng.RecordSource
- - com.devexperts.qd.ng.RecordBuffer

All Implemented Interfaces:

DataConsumer, DataIterator, DataProvider, DataVisitor, RecordConsumer, RecordProvider, RecordSink, SubscriptionConsumer, SubscriptionIterator, SubscriptionProvider, SubscriptionVisitor
```
public final class RecordBuffer
extends RecordSource
implements RecordProvider, RecordSink, DataConsumer, SubscriptionConsumer, RecordConsumer
```
Buffers int and obj values of data records. This class has two cursors of its own -- one is used for read and is returned by cursorAt(long), current(), and next() methods, the other is used for write and is returned by add(com.devexperts.qd.DataRecord, int, java.lang.String) method. This class is faster replacement for deprecated DataBuffer and SubscriptionBuffer classes.
This class is not synchronized and is not thread-safe without external synchronization.

Field Summary
- Fields inherited from class com.devexperts.qd.ng.RecordSource
  VOID
- Fields inherited from interface com.devexperts.qd.ng.RecordProvider
  VOID
- Fields inherited from interface com.devexperts.qd.ng.RecordSink
  VOID
- Fields inherited from interface com.devexperts.qd.DataConsumer
  VOID
- Fields inherited from interface com.devexperts.qd.SubscriptionConsumer
  VOID

Constructor Summary

Constructors
Constructor and Description

RecordBuffer()
Creates new RecordBuffer with a default mode of DATA.

RecordBuffer(RecordMode mode)
Creates new RecordBuffer with a specified mode.

Constructors
Constructor and Description
`RecordBuffer()` Creates new `RecordBuffer` with a default mode of `DATA`.
`RecordBuffer(RecordMode mode)` Creates new `RecordBuffer` with a specified mode.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RecordCursor`	`add(DataRecord record, int cipher, String symbol)` Returns write cursor at the current limit and advances limit.
`RecordCursor`	`add(RecordCursor from)` Adds a record to this buffer from the specified `RecordCursor` and returns write cursor to the recently added record.
`void`	`addAll(RecordSource source)` Deprecated. Use `process(RecordSource)`.
`void`	`addAll(RecordSource source, SubscriptionFilter filter)` Deprecated. Use `process(RecordSource, SubscriptionFilter)`.
`RecordCursor`	`addDataAndCompactIfNeeded(RecordCursor from)` Adds record with data from the specified `RecordCursor`.
`void`	`append(RecordCursor from)` Adds a record to this buffer from the specified `RecordCursor`.
`void`	`cleanup(RecordCursor cursor)` Cleanups the data at the corresponding cursor and reduces `size()` by one.
`void`	`clear()` Clears this record buffers completely, invalidating read and write cursors, resetting its `size`, `position` and `limit` to zero.
`void`	`compact()` Compacts data by copying everything between position and limit to the beginning of the buffer.
`boolean`	`compact(RecordFilter filter)` Compacts data by copying all records that are accepted by filter between position and limit to the beginning of the buffer.
`RecordCursor`	`current()` Returns read cursor at the current position.
`RecordCursor`	`cursorAt(long position)` Returns read cursor at a specified position.
`void`	`flagFrom(long position, int eventFlags)` Flags records that are found by following back a chain of `links` from the given `position` up until (but not before) this buffer's `position`.
`void`	`flush()` Signal that it is safe to flush `appended` records to disk, e.g.
`int`	`getCipher()` Deprecated. Use `next()` and `RecordCursor.getCipher()`
`int`	`getCipherAt(long position)` Returns cipher at the specified position.
`long`	`getEventTimeSequenceAt(long position)` Returns event time sequence at the specified position.
`static RecordBuffer`	`getInstance()` Returns instance from thread-local pool with a default mode of `RecordMode.DATA`.
`static RecordBuffer`	`getInstance(RecordMode mode)` Returns instance from thread-local pool with a specified mode.
`long`	`getLimit()` Returns limit of this buffer, which is the position of the record that will be added with `add(com.devexperts.qd.DataRecord, int, java.lang.String)` method.
`RecordMode`	`getMode()` Returns current mode of this record buffer.
`long`	`getPosition()` Returns position of the current record.
`DataRecord`	`getRecordAt(long position)` Returns record at the specified position.
`String`	`getSymbol()` Deprecated. Use `next()` and `RecordCursor.getSymbol()`
`String`	`getSymbolAt(long position)` Returns symbol at the specified position.
`long`	`getTime()` Deprecated. Use `next()` and `RecordCursor.getTime()`
`boolean`	`hasCapacity()` Returns `true` when this record buffer is not `capacity-limited` (which is default) or, when buffer is capacity-limited, when more records can be added to it.
`boolean`	`hasEstimatedCapacityForBytes(int bytes)` Returns `true` if this record buffer has an estimated capacity to hold a result of parsing a specified number of bytes in binary encoding before becoming too big to be `released` into a pool.
`boolean`	`hasNext()` Returns `true` when more records can be read from this buffer, that is when `position` is less than `limit`.
`boolean`	`isCapacityLimited()` Returns `true` when this record buffer is capacity-limited.
`boolean`	`isEmpty()` Returns `true` when this buffer is empty, that is when its `size` is zero.
`RecordSource`	`newSource()` Returns new `RecordSource` that reads this record buffer from current `position` to its current `limit` with the same `mode`.
`RecordSource`	`newSource(long start, long end)` Returns new `RecordSource` that reads this record buffer from the specified start position to the specified end position.
`RecordCursor`	`next()` Returns read cursor at the current position and advances position to next record.
`int`	`nextIntField()` Deprecated. Use `next()` and `RecordCursor.getInt(int)`
`Object`	`nextObjField()` Deprecated. Use `next()` and `RecordCursor.getObj(int)`
`DataRecord`	`nextRecord()` Deprecated. Use `next()`
`void`	`process(RecordSource source)` Adds all records from the specified source to this buffer.
`void`	`process(RecordSource source, SubscriptionFilter filter)` Adds all records that match a given filter from the specified source to this buffer.
`void`	`processData(DataIterator it)` Processes data from specified iterator and adds to this record buffer all records.
`void`	`processData(DataIterator it, SubscriptionFilter filter)` Processes data from specified iterator and adds to this record buffer all records that are accepted by the specified filter.
`void`	`processSubscription(SubscriptionIterator it)` Processes subscription from specified iterator and adds to this record buffer all records.
`void`	`processSubscription(SubscriptionIterator it, SubscriptionFilter filter)` Processes subscription from specified iterator and adds to this record buffer all records that are accepted by the specified filter.
`void`	`release()` Releases this `RecordBuffer` to a thread-local pool.
`void`	`removeAt(long position)` Removes record at the specified position.
`void`	`removeRange(long fromPosition, long toPosition)` Removes records from the specified fromPosition inclusive and toPosition exclusive.
`void`	`replaceRecordAt(long position, DataRecord newRecord)` Replaces record at the specified position.
`void`	`replaceSymbolAt(long position, int cipher, String symbol)` Replaces symbol at the specified position.
`boolean`	`retrieve(RecordSink sink)` Retrieves all records from `position` to `limit` into the given sink and advances position while the sink `has capacity`.
`boolean`	`retrieveData(DataVisitor visitor)` Deprecated. Use `retrieve(RecordSink)`
`boolean`	`retrieveSubscription(SubscriptionVisitor visitor)` Deprecated. Use `retrieve(RecordSink)`
`void`	`rewind()` Sets `position` of this buffer to the beginning, so that added record can be retrieved again.
`void`	`setCapacityLimit(int capacityLimit)` Sets the capacity limit in the number of records for this record buffer.
`void`	`setCapacityLimited(boolean capacityLimited)` Changes capacity-limited flag of this record buffer.
`void`	`setDataListener(DataListener listener)` This method is provided for compatibility with a legacy `DataProvider` interface and throws `UnsupportedOperationException`.
`void`	`setLimit(long limit)` Sets new buffer limit and discards everything that written after that point.
`void`	`setMode(RecordMode mode)` Changes current mode of this record buffer.
`void`	`setPosition(long position)` Changes position of the current record.
`void`	`setRecordListener(RecordListener listener)` This method throws `UnsupportedOperationException`.
`void`	`setSubscriptionListener(SubscriptionListener listener)` This method is provided for compatibility with a legacy `SubscriptionProvider` interface and throws `UnsupportedOperationException`.
`int`	`size()` Returns the number of records that were added to this RecordBuffer.
`String`	`toString()` Returns string representation of this buffer for debugging purposes.
`void`	`unlinkFrom(long position)` Unlinks records by following back a chain of `links` from the given `position` up until (but not before) this buffer's `position`.
`void`	`visitIntField(DataIntField field, int value)` Deprecated. Use `add(com.devexperts.qd.DataRecord, int, java.lang.String)` to add records into this buffer.
`void`	`visitObjField(DataObjField field, Object value)` Deprecated. Use `add(com.devexperts.qd.DataRecord, int, java.lang.String)` to add records into this buffer.
`DataVisitor`	`visitor()` Deprecated. Use this implementation of `DataVisitor` interface directly if absolutely needed and reconsider this use completely, because `DataVisitor` is a legacy interface.
`void`	`visitRecord(DataRecord record, int cipher, String symbol)` Deprecated. Use `add(com.devexperts.qd.DataRecord, int, java.lang.String)` to add records into this buffer.
`void`	`visitRecord(DataRecord record, int cipher, String symbol, long time)` Deprecated. Use `add(com.devexperts.qd.DataRecord, int, java.lang.String)` to add records into this buffer.
`RecordCursor`	`writeCurrent()` Returns write cursor at the current position.
`RecordCursor`	`writeCursorAt(long position)` Returns write cursor at a specified position.
`RecordCursor`	`writeNext()` Returns write cursor at the current position and advances position to next record.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecordBuffer
```
public RecordBuffer()
```
    Creates new RecordBuffer with a default mode of DATA. The new record buffer is not capacity-limited by default.
  - RecordBuffer
```
public RecordBuffer(RecordMode mode)
```
    Creates new RecordBuffer with a specified mode. The new record buffer is not capacity-limited by default.
- Method Detail
  - getInstance
```
public static RecordBuffer getInstance()
```
    Returns instance from thread-local pool with a default mode of RecordMode.DATA. This instance can be returned to pool with release() method. The recommended usage pattern is:
    RecordBuffer buf = RecordBuffer.getInstance(); // do some local data transfer via buf buf.release();
    This instance has the same state as returned by a default constructor. In particular, it is not capacity-limited by default.
  - getInstance
```
public static RecordBuffer getInstance(RecordMode mode)
```
    Returns instance from thread-local pool with a specified mode. This instance can be returned to pool with release() method. The recommended usage pattern is:
    RecordBuffer buf = RecordBuffer.getInstance(mode); // do some local data transfer via buf buf.release();
    This instance has the same state as returned by a RecordBuffer(mode) constructor. In particular, it is not capacity-limited by default.
  - release
```
public void release()
```
    Releases this RecordBuffer to a thread-local pool. Many operations on this buffer throw IllegalStateException when invoked on an object that was released into pool (especially modifying ones). Read and write cursors of this buffer become unusable, too.
    There is a limit on how big can be instances (in terms of memory they consume) that are stored in the pool. Instances that are too big are left for GC.
    
    Throws:
    
    IllegalStateException - if object was already released.
    
    See Also:
    
    getInstance()
  - isEmpty
```
public boolean isEmpty()
```
    Returns true when this buffer is empty, that is when its size is zero.
    
    Returns:
    
    true this buffer is empty.
  - size
```
public int size()
```
    Returns the number of records that were added to this RecordBuffer.
  - getMode
```
public RecordMode getMode()
```
    Returns current mode of this record buffer.
    
    Specified by:
    
    getMode in interface RecordProvider
    
    Specified by:
    
    getMode in class RecordSource
    
    Returns:
    
    current mode of this record buffer.
  - setMode
```
public void setMode(RecordMode mode)
```
    Changes current mode of this record buffer. Invocation of this method with the current mode has no effect. Mode can be changed only when buffer is empty.
    
    Parameters:
    
    mode - new mode.
    
    Throws:
    
    NullPointerException - if mode is null.
    
    IllegalStateException - if attempting to change mode of non-empty buffer.
  - isCapacityLimited
```
public boolean isCapacityLimited()
```
    Returns true when this record buffer is capacity-limited. When buffer is capacity-limited, then hasCapacity() will return false when adding more records into this buffer may make it ineligible to be released into pool.
  - setCapacityLimited
```
public void setCapacityLimited(boolean capacityLimited)
```
    Changes capacity-limited flag of this record buffer.
    
    See Also:
    
    isCapacityLimited()
  - setCapacityLimit
```
public void setCapacityLimit(int capacityLimit)
```
    Sets the capacity limit in the number of records for this record buffer.
    
    Parameters:
    
    capacityLimit - the capacity limit
    
    Throws:
    
    IllegalArgumentException - if capacityLimit < 0 (see POOLED_CAPACITY or UNLIMITED_CAPACITY)
  - hasCapacity
```
public boolean hasCapacity()
```
    Returns true when this record buffer is not capacity-limited (which is default) or, when buffer is capacity-limited, when more records can be added to it.
    
    Specified by:
    
    hasCapacity in interface DataVisitor
    
    Specified by:
    
    hasCapacity in interface RecordSink
    
    Specified by:
    
    hasCapacity in interface SubscriptionVisitor
  - hasEstimatedCapacityForBytes
```
public boolean hasEstimatedCapacityForBytes(int bytes)
```
    Returns true if this record buffer has an estimated capacity to hold a result of parsing a specified number of bytes in binary encoding before becoming too big to be released into a pool. It assumes that each int or object item takes at least one bytes.
    
    Parameters:
    
    bytes - the number of bytes.
    
    Returns:
    
    true if this record buffer has an estimated capacity to hold a result of parsing a specified number of bytes in binary encoding.
  - clear
```
public void clear()
```
    Clears this record buffers completely, invalidating read and write cursors, resetting its size, position and limit to zero. The mode and capacity-limiting of this record buffer remains the same.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - rewind
```
public void rewind()
```
    Sets position of this buffer to the beginning, so that added record can be retrieved again.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - newSource
```
public RecordSource newSource()
```
    Returns new RecordSource that reads this record buffer from current position to its current limit with the same mode. It is equivalent to newSource(getPosition(), getLimit()).
    
    Specified by:
    
    newSource in class RecordSource
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
    
    See Also:
    
    newSource(long, long)
  - newSource
```
public RecordSource newSource(long start,
                              long end)
```
    Returns new RecordSource that reads this record buffer from the specified start position to the specified end position.
    
    Specified by:
    
    newSource in class RecordSource
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
    
    See Also:
    
    newSource()
  - getLimit
```
public long getLimit()
```
    Returns limit of this buffer, which is the position of the record that will be added with add(com.devexperts.qd.DataRecord, int, java.lang.String) method.
    
    Specified by:
    
    getLimit in class RecordSource
  - getPosition
```
public long getPosition()
```
    Returns position of the current record. This record will be read by next() and current() methods.
    
    Specified by:
    
    getPosition in class RecordSource
  - setPosition
```
public void setPosition(long position)
```
    Changes position of the current record. Only values that were previously returned by RecordSource.getPosition(), RecordSource.getLimit() or next().getPosition() methods are allowed here.
    
    Specified by:
    
    setPosition in class RecordSource
    
    Parameters:
    
    position - new position.
  - setLimit
```
public void setLimit(long limit)
```
    Sets new buffer limit and discards everything that written after that point. Size is reduced by the number of discarded records. This method also resets write cursor to avoid accidental corruption of data. Only values that were previously returned by getPosition() or getLimit() methods are allowed here.
    
    Throws:
    
    IndexOutOfBoundsException - if limit is invalid or above current limit.
  - getRecordAt
```
public DataRecord getRecordAt(long position)
```
    Returns record at the specified position. This position should have been previously returned by getPosition() method.
    
    Parameters:
    
    position - position of the record to return.
    
    Returns:
    
    record at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - getCipherAt
```
public int getCipherAt(long position)
```
    Returns cipher at the specified position. This position should have been previously returned by getPosition() method.
    
    Parameters:
    
    position - position of the cipher to return.
    
    Returns:
    
    cipher at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - getSymbolAt
```
public String getSymbolAt(long position)
```
    Returns symbol at the specified position. This position should have been previously returned by getPosition() method.
    
    Parameters:
    
    position - position of the symbol to return.
    
    Returns:
    
    symbol at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - getEventTimeSequenceAt
```
public long getEventTimeSequenceAt(long position)
```
    Returns event time sequence at the specified position. This position should have been previously returned by getPosition() method. This method returns zero when getMode().hasEventTimeSequence() returns false.
    
    Parameters:
    
    position - position of the event time sequence to return.
    
    Returns:
    
    event time sequence at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - cursorAt
```
public RecordCursor cursorAt(long position)
```
    Returns read cursor at a specified position. This position should have been previously returned by RecordSource.getPosition() or RecordSource.getLimit() method. Invoking this method at the current position results in the same cursor as the call RecordSource.current() or call to RecordSource.next() without the side effect of advancing position. The result of this method at the current limit is null.
    The mode of the resulting cursor is the same as returned by RecordSource.getMode().
    
    Specified by:
    
    cursorAt in class RecordSource
    
    Returns:
    
    read cursor at the specified position.
  - writeCursorAt
```
public RecordCursor writeCursorAt(long position)
```
    Returns write cursor at a specified position. This position should have been previously returned by getPosition() method.
    
    Returns:
    
    Write cursor at the specified position.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - current
```
public RecordCursor current()
```
    Returns read cursor at the current position. Effect is same as cursorAt(getPosition()), but faster. It is the same as call to RecordSource.next() without the side effect of advancing position.
    The mode of the resulting cursor is the same as returned by RecordSource.getMode().
    
    Specified by:
    
    current in class RecordSource
    
    Returns:
    
    read cursor at the current position.
  - writeCurrent
```
public RecordCursor writeCurrent()
```
    Returns write cursor at the current position. Effect is same as writeCursorAt(getPosition()), but faster.
    
    Returns:
    
    Write cursor at the current position.
  - hasNext
```
public boolean hasNext()
```
    Returns true when more records can be read from this buffer, that is when position is less than limit.
    
    Returns:
    
    true when more records can be read from this buffer.
  - next
```
public RecordCursor next()
```
    Returns read cursor at the current position and advances position to next record. The result of this method is null when position is equal to limit.
    The mode of the resulting cursor is the same as returned by RecordSource.getMode().
    
    Specified by:
    
    next in class RecordSource
    
    Returns:
    
    read cursor at the current position.
  - writeNext
```
public RecordCursor writeNext()
```
    Returns write cursor at the current position and advances position to next record. The result of this method is null when position is equal to limit.
    
    Returns:
    
    write cursor at the current position.
  - add
```
public RecordCursor add(DataRecord record,
                        int cipher,
                        String symbol)
```
    Returns write cursor at the current limit and advances limit.
    
    Returns:
    
    write cursor to the recently added record.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - add
```
public RecordCursor add(RecordCursor from)
```
    Adds a record to this buffer from the specified RecordCursor and returns write cursor to the recently added record. This method is a shortcut to
```
 add(from.getRecord(), from.getCipher(), from.getSymbol()).
     copyFrom(from)
```
    Use faster append(RecordCursor) method if you do not need to change added data.
    This method also copies all extra information (event flags, time marks, time sequence, and attachment) that can be stored under this buffer's mode (note that links are not copied), including cursor-local event flags, time mark and attachment that can be set via its owner's Owner.setEventFlags, Owner.setTimeMark, and Owner.setAttachment methods.
    Returns:
    
    write cursor to the recently added record.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - append
```
public void append(RecordCursor from)
```
    Adds a record to this buffer from the specified RecordCursor. The minimal subset of fields based on current mode and cursor mode is copied. All values are copied when both modes are DATA, only time if at least one of them is HISTORY_SUBSCRIPTION, and nothing is copied if at least one of them is SUBSCRIPTION (without time).
    This method also copies all extra information (event flags, time marks, time sequence, and attachment) that can be stored under this buffer's mode (note that links are not copied), including cursor-local event flags, time mark and attachment that can be set via its owner's Owner.setEventFlags, Owner.setTimeMark, and Owner.setAttachment methods.
    
    Specified by:
    
    append in interface RecordSink
    
    Parameters:
    
    from - the cursor to append from.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - addDataAndCompactIfNeeded
```
public RecordCursor addDataAndCompactIfNeeded(RecordCursor from)
```
    Adds record with data from the specified RecordCursor. If the specified cursor has mode that does not have full data (RecordMode.HISTORY_SUBSCRIPTION or RecordMode.SUBSCRIPTION), then the missing data fields are left at default values.
    Buffer is compacted if it runs out of capacity. After compaction all previously queried long positions (via getPosition() or getLimit() methods) or read cursors become invalid.
    Extra information from the cursor (like event time marks, flags, etc) is NOT added.
    
    Parameters:
    
    from - the cursor to copy data from.
    
    Returns:
    
    write cursor to the recently added record.
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
    
    See Also:
    
    RecordCursor.copyDataFrom(RecordCursor)
  - replaceRecordAt
```
public void replaceRecordAt(long position,
                            DataRecord newRecord)
```
    Replaces record at the specified position.
    
    Parameters:
    
    position - the position.
    
    newRecord - new record.
    
    Throws:
    
    IllegalArgumentException - if replacing cannot be performed because different number of fields needs to be stored between old and new record, which depends on mode.
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - replaceSymbolAt
```
public void replaceSymbolAt(long position,
                            int cipher,
                            String symbol)
```
    Replaces symbol at the specified position.
    
    Parameters:
    
    position - the position.
    
    cipher - new cipher.
    
    symbol - new symbol.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - removeAt
```
public void removeAt(long position)
```
    Removes record at the specified position. All records to the right are shifted. Limit is correspondingly decreased, position have correct value. This method also resets both cursors to avoid accidental corruption of data.
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
  - removeRange
```
public void removeRange(long fromPosition,
                        long toPosition)
```
    Removes records from the specified fromPosition inclusive and toPosition exclusive. All records to the right are shifted. Limit is correspondingly decreased, position have correct value. This method also corrects both cursors or resets them in case the cursors belong to a remove range.
    
    Parameters:
    
    fromPosition - start position
    
    toPosition - end position, exclusive
    
    Throws:
    
    IndexOutOfBoundsException - if position is invalid or above current limit.
    
    IllegalArgumentException - if input positions and internal state of buffer are mismatched.
  - process
```
public void process(RecordSource source)
```
    Adds all records from the specified source to this buffer. This is a shortcut for process(source, null).
    
    Specified by:
    
    process in interface RecordConsumer
    
    Parameters:
    
    source - the source.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - process
```
public void process(RecordSource source,
                    SubscriptionFilter filter)
```
    Adds all records that match a given filter from the specified source to this buffer.
    
    Parameters:
    
    source - the source.
    
    filter - the filter.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - addAll
```
public void addAll(RecordSource source)
```
    Deprecated. Use process(RecordSource).
    
    Adds all records from the specified source to this buffer.
    
    Parameters:
    
    source - the source.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - addAll
```
public void addAll(RecordSource source,
                   SubscriptionFilter filter)
```
    Deprecated. Use process(RecordSource, SubscriptionFilter).
    
    Adds all records that match a given filter from the specified source to this buffer.
    
    Parameters:
    
    source - the source.
    
    filter - the filter.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - processData
```
public void processData(DataIterator it,
                        SubscriptionFilter filter)
```
    Processes data from specified iterator and adds to this record buffer all records that are accepted by the specified filter. When iterator implements RecordSource interface, this method calls addAll((RecordSource) it, filter). Use addAll(RecordSource) or addAll(RecordSource, SubscriptionFilter) directly when iterator is statically known to be RecordSource in the calling code.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - processSubscription
```
public void processSubscription(SubscriptionIterator it,
                                SubscriptionFilter filter)
```
    Processes subscription from specified iterator and adds to this record buffer all records that are accepted by the specified filter. When iterator implements RecordSource interface, this method calls addAll((RecordSource) it, filter). Use addAll(RecordSource) or addAll(RecordSource, SubscriptionFilter) directly when iterator is statically known to be RecordSource in the calling code.
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - visitor
```
public DataVisitor visitor()
```
    Deprecated. Use this implementation of DataVisitor interface directly if absolutely needed and reconsider this use completely, because DataVisitor is a legacy interface.
    
    Returns DataVisitor that adds all records to this buffer. This implementation returns this.
  - compact
```
public void compact()
```
    Compacts data by copying everything between position and limit to the beginning of the buffer. Size is set to the number of remaining records. After compaction all previously queried long positions (via getPosition() or getLimit() methods) or read/write cursors become invalid. This method has the same effect as compact(null).
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
  - compact
```
public boolean compact(RecordFilter filter)
```
    Compacts data by copying all records that are accepted by filter between position and limit to the beginning of the buffer. Size is set to the number of remaining records. After compaction all previously queried long positions (via getPosition() or getLimit() methods) or read/write cursors become invalid.
    
    Parameters:
    
    filter - Filter for records. Only accepted records are retained. null filter is assumed to accept everything.
    
    Returns:
    
    true if any data was filtered out (not accepted by the filter)
    
    Throws:
    
    IllegalStateException - if object was already released into pool.
    
    IllegalArgumentException - if filter is not null and this buffer's mode hasLink.
  - cleanup
```
public void cleanup(RecordCursor cursor)
```
    Cleanups the data at the corresponding cursor and reduces size() by one. The cursor should have been retrieved via one of the following methods: next, current, add(record,cipher,symbol), add(cursor), cursorAt, writeCursorAt
    
    Throws:
    
    IndexOutOfBoundsException - if cursor's position is invalid or above current limit.
    
    IllegalStateException - if the data at the corresponding cursor was already cleared.
  - unlinkFrom
```
public void unlinkFrom(long position)
```
    Unlinks records by following back a chain of links from the given position up until (but not before) this buffer's position. Unlinked records are marked with true result of RecordCursor.isUnlinked() method. If the record at the given position was not previously linked with RecordCursor.setLinkTo method, then only one record is unlinked, otherwise the chain of links is followed till the head of the record buffer.
    
    Parameters:
    
    position - the position to start at.
    
    Throws:
    
    IllegalStateException - if the record at the specified position was already unlinked or if this buffer's mode does not have links.
  - flagFrom
```
public void flagFrom(long position,
                     int eventFlags)
```
    Flags records that are found by following back a chain of links from the given position up until (but not before) this buffer's position. Record's event flags are OR-ed with a give eventFlags.
    
    Parameters:
    
    position - the position to start at.
    
    Throws:
    
    IllegalStateException - if the record at the specified position was unlinked or if this buffer's mode does not have links or does not have event flags.
  - retrieve
```
public boolean retrieve(RecordSink sink)
```
    Retrieves all records from position to limit into the given sink and advances position while the sink has capacity.
    
    Specified by:
    
    retrieve in interface RecordProvider
    
    Specified by:
    
    retrieve in class RecordSource
    
    Parameters:
    
    sink - the sink.
    
    Returns:
    
    true if all data was retrieved, false if sink ran out of capacity and more records remain to retrieve.
  - setRecordListener
```
public void setRecordListener(RecordListener listener)
```
    This method throws UnsupportedOperationException.
    
    Specified by:
    
    setRecordListener in interface RecordProvider
    
    Parameters:
    
    listener - the listener.
  - flush
```
public void flush()
```
    Signal that it is safe to flush appended records to disk, e.g. no locks are currently held.
    This implementation does nothing.
    
    Specified by:
    
    flush in interface RecordSink
  - processData
```
public void processData(DataIterator it)
```
    Processes data from specified iterator and adds to this record buffer all records. This implementation calls processData(it, null). Use addAll(RecordSource) or addAll(RecordSource, SubscriptionFilter) when iterator is statically known to be RecordSource in the calling code.
    
    Specified by:
    
    processData in interface DataConsumer
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - processSubscription
```
public void processSubscription(SubscriptionIterator it)
```
    Processes subscription from specified iterator and adds to this record buffer all records. This implementation calls processSubscription(it, null). Use addAll(RecordSource) or addAll(RecordSource, SubscriptionFilter) when iterator is statically known to be RecordSource in the calling code.
    
    Specified by:
    
    processSubscription in interface SubscriptionConsumer
    
    Throws:
    
    IllegalStateException - when adding records to an object that was already released into pool.
  - nextRecord
```
public DataRecord nextRecord()
```
    Deprecated. Use next()
    
    Description copied from class: RecordSource
    
    Returns next record. Returns null if no more records available.
    
    Specified by:
    
    nextRecord in interface DataIterator
    
    Specified by:
    
    nextRecord in interface SubscriptionIterator
    
    Specified by:
    
    nextRecord in class RecordSource
  - getCipher
```
public int getCipher()
```
    Deprecated. Use next() and RecordCursor.getCipher()
    
    Description copied from class: RecordSource
    
    Returns cipher for the current record returned by last call to DataIterator.nextRecord(). Returns 0 if not encoded or if no current record is being iterated.
    
    Specified by:
    
    getCipher in interface DataIterator
    
    Specified by:
    
    getCipher in interface SubscriptionIterator
    
    Specified by:
    
    getCipher in class RecordSource
  - getSymbol
```
public String getSymbol()
```
    Deprecated. Use next() and RecordCursor.getSymbol()
    
    Description copied from class: RecordSource
    
    Returns symbol for the current record returned by last call to DataIterator.nextRecord(). Returns null if encoded or if no current record is being iterated.
    
    Specified by:
    
    getSymbol in interface DataIterator
    
    Specified by:
    
    getSymbol in interface SubscriptionIterator
    
    Specified by:
    
    getSymbol in class RecordSource
  - getTime
```
public long getTime()
```
    Deprecated. Use next() and RecordCursor.getTime()
    
    Description copied from class: RecordSource
    
    Returns time for the current record returned by last call to SubscriptionIterator.nextRecord(). Returns 0 if not historical or if no current record is being iterated.
    
    Specified by:
    
    getTime in interface SubscriptionIterator
    
    Specified by:
    
    getTime in class RecordSource
  - nextIntField
```
public int nextIntField()
```
    Deprecated. Use next() and RecordCursor.getInt(int)
    
    Description copied from class: RecordSource
    
    Returns next Int-field within current record being iterated.
    
    Specified by:
    
    nextIntField in interface DataIterator
    
    Specified by:
    
    nextIntField in class RecordSource
  - nextObjField
```
public Object nextObjField()
```
    Deprecated. Use next() and RecordCursor.getObj(int)
    
    Description copied from class: RecordSource
    
    Returns next Obj-field within current record being iterated.
    
    Specified by:
    
    nextObjField in interface DataIterator
    
    Specified by:
    
    nextObjField in class RecordSource
  - visitRecord
```
public void visitRecord(DataRecord record,
                        int cipher,
                        String symbol)
```
    Deprecated. Use add(com.devexperts.qd.DataRecord, int, java.lang.String) to add records into this buffer.
    
    Description copied from interface: RecordSink
    
    Visits next record.
    
    Specified by:
    
    visitRecord in interface DataVisitor
    
    Specified by:
    
    visitRecord in interface RecordSink
    
    Throws:
    
    IllegalStateException - if this cursor mode is not DATA.
  - visitRecord
```
public void visitRecord(DataRecord record,
                        int cipher,
                        String symbol,
                        long time)
```
    Deprecated. Use add(com.devexperts.qd.DataRecord, int, java.lang.String) to add records into this buffer.
    
    Description copied from interface: RecordSink
    
    Visits next record.
    
    Specified by:
    
    visitRecord in interface RecordSink
    
    Specified by:
    
    visitRecord in interface SubscriptionVisitor
  - visitIntField
```
public void visitIntField(DataIntField field,
                          int value)
```
    Deprecated. Use add(com.devexperts.qd.DataRecord, int, java.lang.String) to add records into this buffer.
    
    Description copied from interface: RecordSink
    
    Visits next Int-field within current record.
    
    Specified by:
    
    visitIntField in interface DataVisitor
    
    Specified by:
    
    visitIntField in interface RecordSink
  - visitObjField
```
public void visitObjField(DataObjField field,
                          Object value)
```
    Deprecated. Use add(com.devexperts.qd.DataRecord, int, java.lang.String) to add records into this buffer.
    
    Description copied from interface: RecordSink
    
    Visits next Obj-field within current record.
    
    Specified by:
    
    visitObjField in interface DataVisitor
    
    Specified by:
    
    visitObjField in interface RecordSink
  - retrieveData
```
public boolean retrieveData(DataVisitor visitor)
```
    Deprecated. Use retrieve(RecordSink)
    
    Retrieves accumulated data into specified data visitor. Returns true if some data still remains in the provider or false if all accumulated data were retrieved.
    
    Specified by:
    
    retrieveData in interface DataProvider
    
    Specified by:
    
    retrieveData in interface RecordProvider
  - setDataListener
```
public void setDataListener(DataListener listener)
```
    This method is provided for compatibility with a legacy DataProvider interface and throws UnsupportedOperationException.
    
    Specified by:
    
    setDataListener in interface DataProvider
    
    Specified by:
    
    setDataListener in interface RecordProvider
  - retrieveSubscription
```
public boolean retrieveSubscription(SubscriptionVisitor visitor)
```
    Deprecated. Use retrieve(RecordSink)
    
    Retrieves accumulated subscription into specified subscription visitor. Returns true if some subscription still remains in the provider or false if all accumulated subscription were retrieved.
    
    Specified by:
    
    retrieveSubscription in interface RecordProvider
    
    Specified by:
    
    retrieveSubscription in interface SubscriptionProvider
  - setSubscriptionListener
```
public void setSubscriptionListener(SubscriptionListener listener)
```
    This method is provided for compatibility with a legacy SubscriptionProvider interface and throws UnsupportedOperationException.
    
    Specified by:
    
    setSubscriptionListener in interface RecordProvider
    
    Specified by:
    
    setSubscriptionListener in interface SubscriptionProvider
  - toString
```
public String toString()
```
    Returns string representation of this buffer for debugging purposes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this buffer for debugging purposes.

Class RecordBuffer

Field Summary

Fields inherited from class com.devexperts.qd.ng.RecordSource

Fields inherited from interface com.devexperts.qd.ng.RecordProvider

Fields inherited from interface com.devexperts.qd.ng.RecordSink

Fields inherited from interface com.devexperts.qd.DataConsumer

Fields inherited from interface com.devexperts.qd.SubscriptionConsumer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordBuffer

RecordBuffer

Method Detail

getInstance

getInstance

release

isEmpty

size

getMode

setMode

isCapacityLimited

setCapacityLimited

setCapacityLimit

hasCapacity

hasEstimatedCapacityForBytes

clear

rewind

newSource

newSource

getLimit

getPosition

setPosition

setLimit

getRecordAt

getCipherAt

getSymbolAt

getEventTimeSequenceAt

cursorAt

writeCursorAt

current

writeCurrent

hasNext

next

writeNext

add

add

append

addDataAndCompactIfNeeded

replaceRecordAt

replaceSymbolAt

removeAt

removeRange

process

process

addAll

addAll

processData

processSubscription

visitor

compact

compact

cleanup

unlinkFrom

flagFrom

retrieve

setRecordListener

flush

processData

processSubscription

nextRecord

getCipher

getSymbol

getTime

nextIntField

nextObjField

visitRecord

visitRecord

visitIntField

visitObjField