com.amazonaws.services.kinesis.connectors

Class UnmodifiableBuffer<T>

java.lang.Object

com.amazonaws.services.kinesis.connectors.UnmodifiableBuffer<T>

Type Parameters:

T -

All Implemented Interfaces:

IBuffer<T>

public class UnmodifiableBuffer<T>
extends Object
implements IBuffer<T>

This class is a wrapper on an IBuffer that limits the functionality of the buffer. This buffer cannot be added to, and retrieving the list of records returns an unmodifiable list. Calling consumeRecord() or clear() will cause an UnathorizedOperationException to be thrown. Calling getRecords() returns the records wrapped in an UnmodifiableList.

Constructor Summary

Constructors

Constructor and Description
UnmodifiableBuffer(IBuffer<?> buf, List<T> records)
UnmodifiableBuffer(IBuffer<T> buf)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the buffer
void	consumeRecord(T record, int recordBytes, String sequenceNumber) Stores the record in the buffer
boolean	equals(Object obj)
long	getBytesToBuffer() Get the byte size limit of data stored in the buffer before the records are flushed to the emitter
String	getFirstSequenceNumber() Get the sequence number of the first record stored in the buffer.
String	getLastSequenceNumber() Get the sequence number of the last record stored in the buffer.
long	getMillisecondsToBuffer() Get the time limit in milliseconds before the records are flushed to the emitter
long	getNumRecordsToBuffer() Get the record number limit of data stored in the buffer before the records are flushed to the emitter
List<T>	getRecords() Get the records stored in the buffer
int	hashCode()
boolean	shouldFlush() Returns true if the buffer is full and stored records should be sent to the emitter

Methods inherited from class java.lang.Object

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

Constructor Detail

UnmodifiableBuffer

public UnmodifiableBuffer(IBuffer<T> buf)

UnmodifiableBuffer

public UnmodifiableBuffer(IBuffer<?> buf,
                          List<T> records)

Method Detail

getBytesToBuffer

public long getBytesToBuffer()

Description copied from interface: IBuffer

Get the byte size limit of data stored in the buffer before the records are flushed to the emitter

Specified by:

getBytesToBuffer in interface IBuffer<T>

Returns:

byte size limit of buffer

getNumRecordsToBuffer

public long getNumRecordsToBuffer()

Description copied from interface: IBuffer

Get the record number limit of data stored in the buffer before the records are flushed to the emitter

Specified by:

getNumRecordsToBuffer in interface IBuffer<T>

Returns:

record number limit of buffer

getMillisecondsToBuffer

public long getMillisecondsToBuffer()

Description copied from interface: IBuffer

Get the time limit in milliseconds before the records are flushed to the emitter

Specified by:

getMillisecondsToBuffer in interface IBuffer<T>

Returns:

time limit in milleseconds

shouldFlush

public boolean shouldFlush()

Description copied from interface: IBuffer

Returns true if the buffer is full and stored records should be sent to the emitter

Specified by:

shouldFlush in interface IBuffer<T>

Returns:

true if records should be sent to the emitter followed by clearing the buffer

consumeRecord

public void consumeRecord(T record,
                          int recordBytes,
                          String sequenceNumber)

Description copied from interface: IBuffer

Stores the record in the buffer

Specified by:

consumeRecord in interface IBuffer<T>

Parameters:

record - record to be processed

recordBytes - size of the record data in bytes

sequenceNumber - Amazon Kinesis sequence identifier

clear

public void clear()

Description copied from interface: IBuffer

Clears the buffer

Specified by:

clear in interface IBuffer<T>

getFirstSequenceNumber

public String getFirstSequenceNumber()

Description copied from interface: IBuffer

Get the sequence number of the first record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Specified by:

getFirstSequenceNumber in interface IBuffer<T>

Returns:

the sequence number of the first record stored in the buffer

getLastSequenceNumber

public String getLastSequenceNumber()

Description copied from interface: IBuffer

Get the sequence number of the last record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Specified by:

getLastSequenceNumber in interface IBuffer<T>

Returns:

the sequence number of the last record stored in the buffer

getRecords

public List<T> getRecords()

Description copied from interface: IBuffer

Get the records stored in the buffer

Specified by:

getRecords in interface IBuffer<T>

Returns:

the records stored in the buffer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object