com.hazelcast.map.impl.querycache.accumulator

Class DefaultCyclicBuffer<E extends Sequenced>

java.lang.Object

com.hazelcast.map.impl.querycache.accumulator.DefaultCyclicBuffer<E>

Type Parameters:

E - the element to be placed in this buffer.

All Implemented Interfaces:

CyclicBuffer<E>

public class DefaultCyclicBuffer<E extends Sequenced>
extends Object
implements CyclicBuffer<E>

Default implementation of CyclicBuffer interface. This class is not thread-safe and only one thread can access it at a time.

See Also:

CyclicBuffer

Constructor Summary

Constructors

Constructor and Description
DefaultCyclicBuffer(int capacity)

Method Summary

Modifier and Type	Method and Description
void	add(E event) Adds an event to this buffer and sets tail to the sequence of given event.
E	get(long sequence) Returns the element in this buffer which has the supplied sequence.
E	getAndAdvance() Returns next unread event from this buffer and advances head sequence of this buffer by one.
long	getHeadSequence() Returns the sequence number of the element in the head index of this buffer if there exists any, otherwise -1L will be returned.
void	reset() Resets this buffer; after the return of this method buffer will be empty and all elements in it will be null.
boolean	setHead(long sequence) Sets head of this buffer to the supplied sequence and returns true, if that sequence is still in this buffer.
int	size() Returns the size of unread events in this buffer according to the current head.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCyclicBuffer

public DefaultCyclicBuffer(int capacity)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

add

public void add(E event)

Description copied from interface: CyclicBuffer

Adds an event to this buffer and sets tail to the sequence of given event.

Specified by:

add in interface CyclicBuffer<E extends Sequenced>

Parameters:

event - the event to be added.

get

public E get(long sequence)

Description copied from interface: CyclicBuffer

Returns the element in this buffer which has the supplied sequence.

Specified by:

get in interface CyclicBuffer<E extends Sequenced>

Parameters:

sequence - the sequence number of the event.

Returns:

the element with the supplied sequence.

setHead

public boolean setHead(long sequence)

Description copied from interface: CyclicBuffer

Sets head of this buffer to the supplied sequence and returns true, if that sequence is still in this buffer. Otherwise, returns false

Specified by:

setHead in interface CyclicBuffer<E extends Sequenced>

Parameters:

sequence - the sequence number which will be set to head of this buffer.

Returns:

true if sequence is set to head, otherwise returns false.

getAndAdvance

public E getAndAdvance()

Description copied from interface: CyclicBuffer

Returns next unread event from this buffer and advances head sequence of this buffer by one.

Specified by:

getAndAdvance in interface CyclicBuffer<E extends Sequenced>

Returns:

next unread event.

reset

public void reset()

Description copied from interface: CyclicBuffer

Resets this buffer; after the return of this method buffer will be empty and all elements in it will be null.

Specified by:

reset in interface CyclicBuffer<E extends Sequenced>

size

public int size()

Description copied from interface: CyclicBuffer

Returns the size of unread events in this buffer according to the current head.

Specified by:

size in interface CyclicBuffer<E extends Sequenced>

Returns:

the size of unread events in this buffer.

getHeadSequence

public long getHeadSequence()

Description copied from interface: CyclicBuffer

Returns the sequence number of the element in the head index of this buffer if there exists any, otherwise -1L will be returned.

Specified by:

getHeadSequence in interface CyclicBuffer<E extends Sequenced>

Returns:

the sequence number of the element in the head index or -1L.