org.axonframework.kafka.eventhandling.consumer

Class SortedKafkaMessageBuffer<E extends Comparable & KafkaMetadataProvider>

java.lang.Object

org.axonframework.kafka.eventhandling.consumer.SortedKafkaMessageBuffer<E>

Type Parameters:

E - element type.

All Implemented Interfaces:

Buffer<E>

public class SortedKafkaMessageBuffer<E extends Comparable & KafkaMetadataProvider>
extends Object
implements Buffer<E>

Thread safe buffer for storing incoming Kafka messages in sorted order defined via Comparable.

Author:

Nakul Mishra.

Constructor Summary

Constructors

Constructor and Description
SortedKafkaMessageBuffer()
SortedKafkaMessageBuffer(int capacity)

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the messages from this buffer.
boolean	isEmpty()
E	peek() Retrieves, but does not remove, the first message of this buffer, or returns null if this buffer is empty.
E	poll(long timeout, TimeUnit unit) Retrieves and removes the first message of this buffer, waiting up to the specified wait time if necessary for a message to become available.
void	put(E e) Inserts the specified message in this buffer, waiting for space to become available if the buffer is full.
void	putAll(Collection<E> c)
int	remainingCapacity() Returns the number of additional elements that this buffer can ideally (in the absence of memory or resource constraints) accept without blocking.
int	size() Returns the number of elements in this buffer.
E	take() Retrieves and removes the first messages of this buffer, waiting if necessary until a message becomes available.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedKafkaMessageBuffer

public SortedKafkaMessageBuffer()

SortedKafkaMessageBuffer

public SortedKafkaMessageBuffer(int capacity)

Parameters:

capacity - the capacity of this buffer.

Method Detail

put

public void put(E e)
         throws InterruptedException

Inserts the specified message in this buffer, waiting for space to become available if the buffer is full.

Specified by:

put in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Throws:

InterruptedException

NullPointerException

putAll

public void putAll(Collection<E> c)
            throws InterruptedException

Specified by:

putAll in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Throws:

InterruptedException

poll

public E poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Retrieves and removes the first message of this buffer, waiting up to the specified wait time if necessary for a message to become available.

Specified by:

poll in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the first message of this buffer, or null if the specified waiting time elapses before a message is available

Throws:

InterruptedException - if interrupted while waiting

take

public E take()
       throws InterruptedException

Retrieves and removes the first messages of this buffer, waiting if necessary until a message becomes available.

Specified by:

take in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Returns:

the first message of this buffer.

Throws:

InterruptedException - if interrupted while waiting

peek

public E peek()

Retrieves, but does not remove, the first message of this buffer, or returns null if this buffer is empty.

Specified by:

peek in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Returns:

the message.

size

public int size()

Returns the number of elements in this buffer.

Specified by:

size in interface Buffer<E extends Comparable & KafkaMetadataProvider>

Returns:

the number of elements in this buffer

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Buffer<E extends Comparable & KafkaMetadataProvider>

remainingCapacity

public int remainingCapacity()

Returns the number of additional elements that this buffer can ideally (in the absence of memory or resource constraints) accept without blocking. This is always equal to the initial capacity of this buffer less the current size of this buffer.

Note that you cannot always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be the case that another thread is about to insert or remove an element.

Specified by:

remainingCapacity in interface Buffer<E extends Comparable & KafkaMetadataProvider>

clear

public void clear()

Removes all of the messages from this buffer.

Specified by:

clear in interface Buffer<E extends Comparable & KafkaMetadataProvider>

toString

public String toString()

Overrides:

toString in class Object