TurnArray (lecousin.net Java core framework 0.16.2 API)

java.lang.Object
- net.lecousin.framework.collections.TurnArray<T>

Type Parameters:

T - type of elements

All Implemented Interfaces:

Iterable<T>, Collection<T>, Deque<T>, Queue<T>
```
public class TurnArray<T>
extends Object
implements Deque<T>
```
Implementation of Deque using an array in an efficient way. It keeps the index of the first and last element. When removing the first element, the other elements are not moved, and the first element is now at index 1 in the internal array. When reaching the end of the array, if the first element is not at the index 0, it can use the index 0 as the last index, such as the element at index 0 in the array becomes the element after the element at index array.length - 1.
This allows removing/adding an element at the head to be as efficient as removing/adding at the tail (no need to copy elements as in a classical array). When full, its size is increased by half of the current size. When removing an element and the size used becomes below half of the array, the array size is divided by 2, but this operation is done in a separate task (priority LOW) such as the remove operation is not slow down. When the task is executed, if the used size increased in the meantime, the task does nothing.

Constructor Summary

Constructors
Constructor and Description
`TurnArray()` Initialize with a size of 5.
`TurnArray(int initSize)` Initialize with the given initial size.
`TurnArray(int initSize, int minSize)` Initialize with the given initial size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T e)`
`boolean`	`addAll(Collection<? extends T> elements)`
`void`	`addFirst(T e)`
`void`	`addLast(T element)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)` The implementation of this operation has not been optimised.
`Iterator<T>`	`descendingIterator()`
`T`	`element()`
`T`	`getFirst()`
`T`	`getLast()`
`boolean`	`isEmpty()`
`boolean`	`isFull()`
`Iterator<T>`	`iterator()`
`boolean`	`offer(T e)`
`boolean`	`offerFirst(T e)`
`boolean`	`offerLast(T e)`
`T`	`peek()`
`T`	`peekFirst()`
`T`	`peekLast()`
`T`	`poll()`
`T`	`pollFirst()`
`T`	`pollLast()`
`T`	`pop()`
`void`	`push(T e)`
`T`	`remove()`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)` The implementation of this operation has not been optimised.
`List<T>`	`removeAllNoOrder()` Remove all elements and return them, but the returned list is not ordered.
`boolean`	`removeAny(Object element)` remove this element, not necessarily the first or last occurrence.
`T`	`removeFirst()`
`boolean`	`removeFirstOccurrence(Object element)`
`boolean`	`removeInstance(T element)` Remove the given instance.
`T`	`removeLast()`
`boolean`	`removeLastOccurrence(Object element)`
`boolean`	`retainAll(Collection<?> c)` Not implemented.
`int`	`size()`
`Object[]`	`toArray()`
`<U> U[]`	`toArray(U[] a)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - TurnArray
```
public TurnArray()
```
    Initialize with a size of 5.
  - TurnArray
```
public TurnArray(int initSize)
```
    Initialize with the given initial size.
  - TurnArray
```
public TurnArray(int initSize,
                 int minSize)
```
    Initialize with the given initial size.
- Method Detail
  - isFull
```
public boolean isFull()
```
  - addLast
```
public void addLast(T element)
```
    Specified by:
    
    addLast in interface Deque<T>
  - addFirst
```
public void addFirst(T e)
```
    Specified by:
    
    addFirst in interface Deque<T>
  - addAll
```
public boolean addAll(Collection<? extends T> elements)
```
    Specified by:
    
    addAll in interface Collection<T>
  - removeFirst
```
public T removeFirst()
```
    Specified by:
    
    removeFirst in interface Deque<T>
  - removeLast
```
public T removeLast()
```
    Specified by:
    
    removeLast in interface Deque<T>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T>
  - getFirst
```
public T getFirst()
```
    Specified by:
    
    getFirst in interface Deque<T>
  - getLast
```
public T getLast()
```
    Specified by:
    
    getLast in interface Deque<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T>
    
    Specified by:
    
    size in interface Deque<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<T>
  - add
```
public boolean add(T e)
```
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface Deque<T>
    
    Specified by:
    
    add in interface Queue<T>
  - offer
```
public boolean offer(T e)
```
    Specified by:
    
    offer in interface Deque<T>
    
    Specified by:
    
    offer in interface Queue<T>
  - offerFirst
```
public boolean offerFirst(T e)
```
    Specified by:
    
    offerFirst in interface Deque<T>
  - offerLast
```
public boolean offerLast(T e)
```
    Specified by:
    
    offerLast in interface Deque<T>
  - peek
```
public T peek()
```
    Specified by:
    
    peek in interface Deque<T>
    
    Specified by:
    
    peek in interface Queue<T>
  - peekFirst
```
public T peekFirst()
```
    Specified by:
    
    peekFirst in interface Deque<T>
  - peekLast
```
public T peekLast()
```
    Specified by:
    
    peekLast in interface Deque<T>
  - poll
```
public T poll()
```
    Specified by:
    
    poll in interface Deque<T>
    
    Specified by:
    
    poll in interface Queue<T>
  - pollFirst
```
public T pollFirst()
```
    Specified by:
    
    pollFirst in interface Deque<T>
  - pollLast
```
public T pollLast()
```
    Specified by:
    
    pollLast in interface Deque<T>
  - push
```
public void push(T e)
```
    Specified by:
    
    push in interface Deque<T>
  - pop
```
public T pop()
```
    Specified by:
    
    pop in interface Deque<T>
  - element
```
public T element()
```
    Specified by:
    
    element in interface Deque<T>
    
    Specified by:
    
    element in interface Queue<T>
  - remove
```
public T remove()
```
    Specified by:
    
    remove in interface Deque<T>
    
    Specified by:
    
    remove in interface Queue<T>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<T>
    
    Specified by:
    
    contains in interface Deque<T>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    The implementation of this operation has not been optimised.
    
    Specified by:
    
    containsAll in interface Collection<T>
  - removeAny
```
public boolean removeAny(Object element)
```
    remove this element, not necessarily the first or last occurrence.
  - removeFirstOccurrence
```
public boolean removeFirstOccurrence(Object element)
```
    Specified by:
    
    removeFirstOccurrence in interface Deque<T>
  - removeLastOccurrence
```
public boolean removeLastOccurrence(Object element)
```
    Specified by:
    
    removeLastOccurrence in interface Deque<T>
  - removeInstance
```
public boolean removeInstance(T element)
```
    Remove the given instance.
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<T>
    
    Specified by:
    
    remove in interface Deque<T>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    The implementation of this operation has not been optimised.
    
    Specified by:
    
    removeAll in interface Collection<T>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Not implemented.
    
    Specified by:
    
    retainAll in interface Collection<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
    
    Specified by:
    
    iterator in interface Deque<T>
  - descendingIterator
```
public Iterator<T> descendingIterator()
```
    Specified by:
    
    descendingIterator in interface Deque<T>
  - removeAllNoOrder
```
public List<T> removeAllNoOrder()
```
    Remove all elements and return them, but the returned list is not ordered. The reason it is not ordered is for performance, when the order is not important.
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T>
  - toArray
```
public <U> U[] toArray(U[] a)
```
    Specified by:
    
    toArray in interface Collection<T>

Class TurnArray<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

TurnArray

TurnArray

TurnArray

Method Detail

isFull

addLast

addFirst

addAll

removeFirst

removeLast

isEmpty

getFirst

getLast

size

clear

add

offer

offerFirst

offerLast

peek

peekFirst

peekLast

poll

pollFirst

pollLast

push

pop

element

remove

contains

containsAll

removeAny

removeFirstOccurrence

removeLastOccurrence

removeInstance

remove

removeAll

retainAll

iterator

descendingIterator

removeAllNoOrder

toArray

toArray