FIFOQueue (utils4j)

java.lang.Object
- com.varra.util.FIFOQueue<E>

Type Parameters:

E - the element type LinkedList does not provide synchronization by default. And it behaves like fixed and not fixed. We can make it as fixed by providing the isFixed tag as true. something as below..
FIFOQueue fifoQueue = new FIFOQueue(1000, true);
It has buffer overflow notifications too. And notifies the listeners with the removed event if any registered to it.

by default it is Not fixed.

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, List<E>
```
public class FIFOQueue<E>
extends Object
implements Collection<E>, List<E>, Serializable
```
It adds the thread-safe functionality to the LinkedList where all the operations from/to this list are synchronized.
And it adds the fixed size functionality too to LinkedList where as LinkedList does not provide it by default.

Version:

1.0

Author:

Rajakrishna V. Reddy

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`FIFOQueue()` Creates a list of small initial capacity.
`FIFOQueue(Collection<? extends E> values)` Creates a list containing the specified values, in the order they are returned by the collection's iterator.
`FIFOQueue(int capacity, boolean isFixed)` Creates a list of specified initial capacity if the `FIFOQueue` is not fixed, else it creates a Queue of the specified length; unless the list size reaches the specified capacity, operations on this list will not allocate memory (no lazy object creation).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E element)` Adds the.
`boolean`	`addAll(Collection<? extends E> c)` Adds the all.
`boolean`	`addAll(int index, Collection<? extends E> values)` Adds the all.
`void`	`addFIFOQueueItemRemovedListener(BufferOverflowListener<E> listener)` Adds the FIFOQueueItemRemovedListener to the list so that it can be notified with an item that is to be removed.
`void`	`addFirst(E value)` Inserts the specified value at the beginning of this list.
`boolean`	`addLast(E value)` Appends the specified value to the end of this list (fast).
`void`	`await()` Causes the current thread to wait until it is signalled or.
`void`	`await(long time, TimeUnit unit)` Causes the current thread to wait until it is signalled or specified time is elapsed.
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object obj)`
`E`	`get(int index)`
`E`	`getFirst()` Returns the first value of this list.
`E`	`getLast()` Returns the last value of this list.
`int`	`indexOf(Object value)`
`boolean`	`isEmpty()`
`boolean`	`isFixed()` Checks if is fixed.
`Iterator<E>`	`iterator()`
`int`	`lastIndexOf(Object value)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(int index)`
`E`	`pop()` Pops the element from the Queue.
`void`	`push(E value)` Pushes the specified value at the beginning of this Queue.
`E`	`remove(int index)`
`boolean`	`remove(Object value)`
`boolean`	`removeAll(Collection<?> c)`
`void`	`removeFIFOQueueItemRemovedListener(BufferOverflowListener<E> listener)` Removes the FIFOQueueItemRemovedListener from the list.
`E`	`removeFirst()` Removes and returns the first value of this list.
`E`	`removeLast()` Removes and returns the last value of this list (fast).
`boolean`	`retainAll(Collection<?> c)`
`E`	`set(int index, E element)` Sets the.
`void`	`signal()` Wakes up one waiting thread.
`void`	`signalAll()` Wakes up all waiting threads.
`int`	`size()`
`List<E>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] array)`
`String`	`toString()`

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

Methods inherited from interface java.util.List
hashCode, replaceAll, sort, spliterator

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - FIFOQueue
```
public FIFOQueue()
```
    Creates a list of small initial capacity.
  - FIFOQueue
```
public FIFOQueue(int capacity,
                 boolean isFixed)
```
    Creates a list of specified initial capacity if the FIFOQueue is not fixed, else it creates a Queue of the specified length; unless the list size reaches the specified capacity, operations on this list will not allocate memory (no lazy object creation).
    
    Parameters:
    
    capacity - the initial capacity.
    
    isFixed - the flag to tell whether it is gonna be fixed or not.
  - FIFOQueue
```
public FIFOQueue(Collection<? extends E> values)
```
    Creates a list containing the specified values, in the order they are returned by the collection's iterator.
    
    Parameters:
    
    values - the values to be placed into this list.
- Method Detail
  - remove
```
public boolean remove(Object value)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Adds the all.
    
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface List<E>
    
    Parameters:
    
    c - the c
    
    Returns:
    
    true, if successful
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface List<E>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface List<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - toArray
```
public <T> T[] toArray(T[] array)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<E>
    
    Specified by:
    
    equals in interface List<E>
    
    Overrides:
    
    equals in class Object
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends E> values)
```
    Adds the all.
    
    Specified by:
    
    addAll in interface List<E>
    
    Parameters:
    
    index - the index
    
    values - the values
    
    Returns:
    
    true, if successful
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface List<E>
  - set
```
public E set(int index,
             E element)
```
    Sets the.
    
    Specified by:
    
    set in interface List<E>
    
    Parameters:
    
    index - the index
    
    element - the element
    
    Returns:
    
    the e
  - add
```
public void add(int index,
                E element)
```
    Adds the.
    
    Specified by:
    
    add in interface List<E>
    
    Parameters:
    
    index - the index
    
    element - the element
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface List<E>
  - indexOf
```
public int indexOf(Object value)
```
    Specified by:
    
    indexOf in interface List<E>
  - lastIndexOf
```
public int lastIndexOf(Object value)
```
    Specified by:
    
    lastIndexOf in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<E>
  - subList
```
public List<E> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<E>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface List<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface List<E>
  - getFirst
```
public final E getFirst()
```
    Returns the first value of this list.
    
    Returns:
    
    this list's first value.
  - getLast
```
public final E getLast()
```
    Returns the last value of this list.
    
    Returns:
    
    this list's last value.
  - addFirst
```
public final void addFirst(E value)
```
    Inserts the specified value at the beginning of this list.
    
    Parameters:
    
    value - the value to be inserted.
  - addLast
```
public boolean addLast(E value)
```
    Appends the specified value to the end of this list (fast).
    
    Parameters:
    
    value - the value to be inserted.
    
    Returns:
    
    true, if successful
  - push
```
public final void push(E value)
```
    Pushes the specified value at the beginning of this Queue. This is same as addFirst(Object) , but kept for naming conventions.
    
    Parameters:
    
    value - the value to be inserted.
  - pop
```
public E pop()
```
    Pops the element from the Queue. This is same as removeLast(), but kept for naming conventions.
    
    Returns:
    
    The value to be popped.
  - removeFirst
```
public final E removeFirst()
```
    Removes and returns the first value of this list.
    
    Returns:
    
    this list's first value before this call.
  - removeLast
```
public final E removeLast()
```
    Removes and returns the last value of this list (fast).
    
    Returns:
    
    this list's last value before this call.
  - isFixed
```
public boolean isFixed()
```
    Checks if is fixed.
    
    Returns:
    
    the isFixed
  - addFIFOQueueItemRemovedListener
```
public void addFIFOQueueItemRemovedListener(BufferOverflowListener<E> listener)
```
    Adds the FIFOQueueItemRemovedListener to the list so that it can be notified with an item that is to be removed.
    
    Parameters:
    
    listener - the listener
  - removeFIFOQueueItemRemovedListener
```
public void removeFIFOQueueItemRemovedListener(BufferOverflowListener<E> listener)
```
    Removes the FIFOQueueItemRemovedListener from the list.
    
    Parameters:
    
    listener - the listener
  - await
```
public void await()
           throws InterruptedException
```
    Causes the current thread to wait until it is signalled or.
    
    Throws:
    
    InterruptedException - the interrupted exception interrupted.
  - await
```
public void await(long time,
                  TimeUnit unit)
           throws InterruptedException
```
    Causes the current thread to wait until it is signalled or specified time is elapsed.
    
    Parameters:
    
    time - the time
    
    unit - the unit
    
    Throws:
    
    InterruptedException - the interrupted exception interrupted.
  - signal
```
public void signal()
```
    Wakes up one waiting thread.
    If any threads are waiting on this condition then one is selected for waking up. That thread must then re-acquire the lock before returning from await.
  - signalAll
```
public void signalAll()
```
    Wakes up all waiting threads.
    If any threads are waiting on this condition then they are all woke up. Each thread must re-acquire the lock before it can return from await.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FIFOQueue<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

FIFOQueue

FIFOQueue

FIFOQueue

Method Detail

remove

addAll

containsAll

removeAll

retainAll

toArray

toArray

equals

addAll

get

set

add

remove

indexOf

lastIndexOf

listIterator

subList

size

isEmpty

contains

iterator

add

clear

listIterator

getFirst

getLast

addFirst

addLast

push

pop

removeFirst

removeLast

isFixed

addFIFOQueueItemRemovedListener

removeFIFOQueueItemRemovedListener

await

await

signal

signalAll

toString