org.hawkular.metrics.client.common

Class BoundMetricFifo

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<SingleMetric>

org.hawkular.metrics.client.common.BoundMetricFifo

All Implemented Interfaces:

Iterable<SingleMetric>, Collection<SingleMetric>, Queue<SingleMetric>

public class BoundMetricFifo
extends AbstractQueue<SingleMetric>
implements Queue<SingleMetric>

A Fifo with a fixed maximum size. If the maximum size is reached, old elements are pushed out to make room for the new arrivals. Access is internally synchronized. There are special methods #getList and #cleanout that can be used to retrieve a list of items for further processing so that the fifo can still be offered new items. If the list processing was successful, #cleanout can be used to remove those items from the fifo.

Author:

Heiko W. Rupp

Constructor Summary

Constructors

Constructor and Description
BoundMetricFifo(int initialSize, int maxSize) Create a new Fifo with an initial internal capacity of initialSize and a maximum capacity of maxSize.

Method Summary

Modifier and Type	Method and Description
boolean	cleanout(Collection<SingleMetric> metrics) Remove the collection of passed metrics from the fifo.
boolean	cleanout(SingleMetric metric) Remove the single passed metric from the fifo
List<SingleMetric>	getList() Retrieve a copy of the current items in the fifo.
Iterator<SingleMetric>	iterator()
boolean	offer(SingleMetric singleMetric) Add an object to the Fifo.
SingleMetric	peek()
SingleMetric	poll()
int	size()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Queue

add, element, remove

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BoundMetricFifo

public BoundMetricFifo(int initialSize,
                       int maxSize)

Create a new Fifo with an initial internal capacity of initialSize and a maximum capacity of maxSize.

Parameters:

initialSize - Initial internal capacity.

maxSize - Maximum capacity of the Fifo.

Method Detail

iterator

public Iterator<SingleMetric> iterator()

Specified by:

iterator in interface Iterable<SingleMetric>

Specified by:

iterator in interface Collection<SingleMetric>

Specified by:

iterator in class AbstractCollection<SingleMetric>

size

public int size()

Specified by:

size in interface Collection<SingleMetric>

Specified by:

size in class AbstractCollection<SingleMetric>

offer

public boolean offer(SingleMetric singleMetric)

Add an object to the Fifo. If the Fifo is full, then the oldest item is removed first.

Specified by:

offer in interface Queue<SingleMetric>

Parameters:

singleMetric - Metric to add

Returns:

true if adding was successful

poll

public SingleMetric poll()

Specified by:

poll in interface Queue<SingleMetric>

peek

public SingleMetric peek()

Specified by:

peek in interface Queue<SingleMetric>

cleanout

public boolean cleanout(SingleMetric metric)

Remove the single passed metric from the fifo

Parameters:

metric - Metric to remove

Returns:

true if it was removed, false otherwise (e.g. if the metric was not in the fifo)

cleanout

public boolean cleanout(Collection<SingleMetric> metrics)

Remove the collection of passed metrics from the fifo.

Parameters:

metrics - Metrics to remove

Returns:

true if all Metrics were removed, false otherwise (e.g. if one metric was not in the fifo)

getList

public List<SingleMetric> getList()

Retrieve a copy of the current items in the fifo. The original content of the fifo is not changed.

Returns:

A copy of the items in the fifo.