SynchronizedEvictingRingBuffer (Wavefront Shared Java Library 2020-01.2 API)

java.lang.Object
- java.util.AbstractCollection<T>
- - com.wavefront.common.EvictingRingBuffer<T>
  - - com.wavefront.common.SynchronizedEvictingRingBuffer<T>

Type Parameters:

T - type of objects stored

All Implemented Interfaces:

Serializable, Cloneable, Iterable<T>, Collection<T>, Queue<T>, RandomAccess
```
@ThreadSafe
public class SynchronizedEvictingRingBuffer<T>
extends EvictingRingBuffer<T>
```
A thread-safe implementation of a basic ring buffer with an ability to evict values on overflow.

Author:

vasily@wavefont.com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SynchronizedEvictingRingBuffer(int capacity)`
`SynchronizedEvictingRingBuffer(int capacity, boolean throwOnOverflow)`
`SynchronizedEvictingRingBuffer(int capacity, boolean throwOnOverflow, T defaultValue)`
`SynchronizedEvictingRingBuffer(int capacity, T defaultValue)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T value)` Add a value at the end of the ring buffer.
`boolean`	`addAll(Collection<? extends T> coll)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> coll)`
`T`	`element()` Retrieves, but does not remove, the head of this buffer.
`boolean`	`equals(Object obj)`
`void`	`forEach(java.util.function.Consumer<? super T> consumer)`
`T`	`get(int index)` Return the element at the specified position in the buffer.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`offer(T value)` Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
`T`	`peek()` Retrieves, but does not remove, the head of this buffer, or returns null if empty.
`T`	`poll()` Retrieves and removes the head of this buffer, or returns null if empty.
`T`	`remove()` Retrieves and removes the head of this buffer.
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> coll)`
`boolean`	`removeIf(java.util.function.Predicate<? super T> filter)`
`boolean`	`retainAll(Collection<?> coll)`
`int`	`size()` Returns number of elements in the buffer.
`Object[]`	`toArray()`
`<U> U[]`	`toArray(U[] a)`
`List<T>`	`toList()` Returns a `List<T>` containing all the elements in the buffer in proper sequence (first to last element).
`String`	`toString()`

Methods inherited from class com.wavefront.common.EvictingRingBuffer
capacity, clone, iterator

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

Methods inherited from interface java.util.Collection
parallelStream, spliterator, stream

- Constructor Detail
  - SynchronizedEvictingRingBuffer
```
public SynchronizedEvictingRingBuffer(int capacity)
```
    Parameters:
    
    capacity - desired capacity.
  - SynchronizedEvictingRingBuffer
```
public SynchronizedEvictingRingBuffer(int capacity,
                                      boolean throwOnOverflow)
```
    Parameters:
    
    capacity - desired capacity
    
    throwOnOverflow - Disables auto-eviction on overflow. When full capacity is reached, all subsequent append() operations would throw IllegalStateException if this parameter is true, or evict the oldest value if this parameter is false.
  - SynchronizedEvictingRingBuffer
```
public SynchronizedEvictingRingBuffer(int capacity,
                                      @Nullable
                                      T defaultValue)
```
    Parameters:
    
    capacity - desired capacity.
    
    defaultValue - pre-fill the buffer with this default value.
  - SynchronizedEvictingRingBuffer
```
public SynchronizedEvictingRingBuffer(int capacity,
                                      boolean throwOnOverflow,
                                      @Nullable
                                      T defaultValue)
```
    Parameters:
    
    capacity - desired capacity.
    
    throwOnOverflow - disables auto-eviction on overflow. When full capacity is reached, all subsequent append() operations would throw IllegalStateException if this parameter is true, or evict the oldest value if this parameter is false.
    
    defaultValue - pre-fill the buffer with this default value.
- Method Detail
  - size
```
public int size()
```
    Description copied from class: EvictingRingBuffer
    
    Returns number of elements in the buffer.
    
    Specified by:
    
    size in interface Collection<T>
    
    Overrides:
    
    size in class EvictingRingBuffer<T>
    
    Returns:
    
    number of elements
  - get
```
public T get(int index)
```
    Description copied from class: EvictingRingBuffer
    
    Return the element at the specified position in the buffer.
    
    Overrides:
    
    get in class EvictingRingBuffer<T>
    
    Parameters:
    
    index - index of the element to return
    
    Returns:
    
    the element at the specified position in the buffer
  - add
```
public boolean add(T value)
```
    Description copied from class: EvictingRingBuffer
    
    Add a value at the end of the ring buffer.
    
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface Queue<T>
    
    Overrides:
    
    add in class EvictingRingBuffer<T>
    
    Parameters:
    
    value - element to be appended to the end of the buffer
    
    Returns:
    
    true (as specified by Collection#add(T))
  - offer
```
public boolean offer(T value)
```
    Description copied from class: EvictingRingBuffer
    
    Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
    
    Specified by:
    
    offer in interface Queue<T>
    
    Overrides:
    
    offer in class EvictingRingBuffer<T>
    
    Parameters:
    
    value - element to insert
    
    Returns:
    
    true if the element was added, else false
  - toList
```
public List<T> toList()
```
    Description copied from class: EvictingRingBuffer
    
    Returns a List<T> containing all the elements in the buffer in proper sequence (first to last element).
    
    Overrides:
    
    toList in class EvictingRingBuffer<T>
    
    Returns:
    
    a List<T> containing all the elements in the buffer in proper sequence
  - toArray
```
@Nonnull
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Overrides:
    
    toArray in class EvictingRingBuffer<T>
  - remove
```
public T remove()
```
    Description copied from class: EvictingRingBuffer
    
    Retrieves and removes the head of this buffer.
    
    Specified by:
    
    remove in interface Queue<T>
    
    Overrides:
    
    remove in class EvictingRingBuffer<T>
    
    Returns:
    
    removed element
  - poll
```
public T poll()
```
    Description copied from class: EvictingRingBuffer
    
    Retrieves and removes the head of this buffer, or returns null if empty.
    
    Specified by:
    
    poll in interface Queue<T>
    
    Overrides:
    
    poll in class EvictingRingBuffer<T>
    
    Returns:
    
    the head of this buffer or null if empty
  - element
```
public T element()
```
    Description copied from class: EvictingRingBuffer
    
    Retrieves, but does not remove, the head of this buffer. This method differs from peek only in that it throws an exception if empty.
    
    Specified by:
    
    element in interface Queue<T>
    
    Overrides:
    
    element in class EvictingRingBuffer<T>
    
    Returns:
    
    the head of this buffer
  - peek
```
public T peek()
```
    Description copied from class: EvictingRingBuffer
    
    Retrieves, but does not remove, the head of this buffer, or returns null if empty.
    
    Specified by:
    
    peek in interface Queue<T>
    
    Overrides:
    
    peek in class EvictingRingBuffer<T>
    
    Returns:
    
    the head of this buffer or null if empty
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T>
    
    Overrides:
    
    isEmpty in class AbstractCollection<T>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<T>
    
    Overrides:
    
    contains in class AbstractCollection<T>
  - containsAll
```
public boolean containsAll(@Nonnull
                           Collection<?> coll)
```
    Specified by:
    
    containsAll in interface Collection<T>
    
    Overrides:
    
    containsAll in class AbstractCollection<T>
  - addAll
```
public boolean addAll(@Nonnull
                      Collection<? extends T> coll)
```
    Specified by:
    
    addAll in interface Collection<T>
    
    Overrides:
    
    addAll in class AbstractCollection<T>
  - removeAll
```
public boolean removeAll(@Nonnull
                         Collection<?> coll)
```
    Specified by:
    
    removeAll in interface Collection<T>
    
    Overrides:
    
    removeAll in class AbstractCollection<T>
  - retainAll
```
public boolean retainAll(@Nonnull
                         Collection<?> coll)
```
    Specified by:
    
    retainAll in interface Collection<T>
    
    Overrides:
    
    retainAll in class AbstractCollection<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<T>
    
    Overrides:
    
    clear in class AbstractCollection<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCollection<T>
  - forEach
```
public void forEach(java.util.function.Consumer<? super T> consumer)
```
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super T> filter)
```
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<T>
    
    Overrides:
    
    remove in class AbstractCollection<T>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<T>
    
    Overrides:
    
    hashCode in class EvictingRingBuffer<T>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<T>
    
    Overrides:
    
    equals in class EvictingRingBuffer<T>
  - toArray
```
@Nonnull
public <U> U[] toArray(@Nonnull
                                U[] a)
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Overrides:
    
    toArray in class AbstractCollection<T>

Class SynchronizedEvictingRingBuffer<T>

Constructor Summary

Method Summary

Methods inherited from class com.wavefront.common.EvictingRingBuffer

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Constructor Detail

SynchronizedEvictingRingBuffer

SynchronizedEvictingRingBuffer

SynchronizedEvictingRingBuffer

SynchronizedEvictingRingBuffer

Method Detail

size

get

add

offer

toList

toArray

remove

poll

element

peek

isEmpty

contains

containsAll

addAll

removeAll

retainAll

clear

toString

forEach

removeIf

remove

hashCode

equals

toArray