ArrayKeyList (Charba - J2CL and GWT charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.ArrayKeyList<E>

Type Parameters:

E - type of key element

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>
```
public final class ArrayKeyList<E extends Key>
extends Object
```
The user of this interface has precise control over where in the list each element is inserted.
The user can access elements by their integer index (position in the list), and search for elements in the list.
This implementation uses a java script object as back-end to store objects (Key values).

Some methods are annotated with @SuppressWarnings("unusable-by-js") because J2CL transpiler emits warnings as not usable in the javascript part but this collection must not be passed to any javascript code.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description

ArrayKeyList(KeyFactory<E> factory)
Creates an empty list.

Constructors
Constructor and Description
`ArrayKeyList(KeyFactory<E> factory)` Creates an empty list.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)` Appends the specified element to the end of this list
`void`	`add(int index, E element)` Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
`boolean`	`addAll(Collection<? extends E> collection)` Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator
`void`	`addAll(E[] values)` Loads an array of elements in the the list
`boolean`	`addAll(int index, Collection<? extends E> collection)`
`protected boolean`	`checkRange(int index)` Checks if the index is in the right range.
`void`	`clear()` Removes all of the elements from this list.
`boolean`	`contains(Object object)` Returns true if this list contains the specified element.
`boolean`	`containsAll(Collection<?> collection)` Returns true if this list contains all of the elements of the specified collection.
`E`	`get(int index)` Returns the element at the specified position in this list.
`int`	`indexOf(Object object)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`boolean`	`isEmpty()` Returns true if this list contains no elements
`Iterator<E>`	`iterator()` Returns an iterator over the elements in this list in proper sequence.
`int`	`lastIndexOf(Object object)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`ListIterator<E>`	`listIterator()` Returns a list iterator over the elements in this list
`ListIterator<E>`	`listIterator(int index)` Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.
`E`	`remove(int index)` Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
`boolean`	`remove(Object object)` Removes the first occurrence of the specified element from this list, if it is present.
`boolean`	`removeAll(Collection<?> collection)` Removes from this list all of its elements that are contained in the specified collection.
`boolean`	`retainAll(Collection<?> collection)` Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all of its elements that are not contained in the specified collection.
`E`	`set(int index, E element)` Replaces the element at the specified position in this list with the specified element.
`int`	`size()` Returns the number of elements in this list.
`List<E>`	`subList(int fromIndex, int toIndex)` Not implemented
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`String`	`toString()`

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

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

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - ArrayKeyList
```
public ArrayKeyList(KeyFactory<E> factory)
```
    Creates an empty list.
    
    Parameters:
    
    factory - factory instance to create the key from a native one.
- Method Detail
  - addAll
```
public void addAll(E[] values)
```
    Loads an array of elements in the the list
    
    Parameters:
    
    values - an array of elements to be loaded
  - add
```
public boolean add(E element)
```
    Appends the specified element to the end of this list
  - clear
```
public void clear()
```
    Removes all of the elements from this list. The list will be empty after this call returns.
  - get
```
public E get(int index)
```
    Returns the element at the specified position in this list. If index out of range, returns null
  - set
```
public E set(int index,
             E element)
```
    Replaces the element at the specified position in this list with the specified element. If index out of range, returns null
  - add
```
public void add(int index,
                E element)
```
    Inserts the specified element at the specified position in this list.
    Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
  - remove
```
public E remove(int index)
```
    Removes the element at the specified position in this list.
    Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
  - indexOf
```
public int indexOf(Object object)
```
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
  - lastIndexOf
```
public int lastIndexOf(Object object)
```
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
  - toArray
```
public final Object[] toArray()
```
  - retainAll
```
public final boolean retainAll(Collection<?> collection)
```
    Retains only the elements in this list that are contained in the specified collection.
    In other words, removes from this list all of its elements that are not contained in the specified collection.
  - addAll
```
public final boolean addAll(Collection<? extends E> collection)
```
    Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator
  - size
```
public int size()
```
    Returns the number of elements in this list.
    
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this list contains no elements
    
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
  - contains
```
public boolean contains(Object object)
```
    Returns true if this list contains the specified element.
    
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
  - iterator
```
public Iterator<E> iterator()
```
    Returns an iterator over the elements in this list in proper sequence.
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator()
```
    Returns a list iterator over the elements in this list
    
    Specified by:
    
    listIterator in interface List<E>
  - addAll
```
public final boolean addAll(int index,
                            Collection<? extends E> collection)
```
    Specified by:
    
    addAll in interface List<E>
  - remove
```
public final boolean remove(Object object)
```
    Removes the first occurrence of the specified element from this list, if it is present. If this list does not contain the element, it is unchanged.
    
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
  - containsAll
```
public boolean containsAll(Collection<?> collection)
```
    Returns true if this list contains all of the elements of the specified collection.
    
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface List<E>
  - removeAll
```
public final boolean removeAll(Collection<?> collection)
```
    Removes from this list all of its elements that are contained in the specified collection.
    
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
    The specified index indicates the first element that would be returned by an initial call to next.
    An initial call to previous would return the element with the specified index minus one.
    
    Specified by:
    
    listIterator in interface List<E>
  - subList
```
public List<E> subList(int fromIndex,
                       int toIndex)
```
    Not implemented
    
    Specified by:
    
    subList in interface List<E>
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - checkRange
```
protected final boolean checkRange(int index)
```
    Checks if the index is in the right range.
    
    Parameters:
    
    index - index to be checked
    
    Returns:
    
    true if the index is in the right range otherwise false

Class ArrayKeyList<E extends Key>

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

ArrayKeyList

Method Detail

addAll

add

clear

get

set

add

remove

indexOf

lastIndexOf

toArray

retainAll

addAll

size

isEmpty

contains

iterator

toArray

listIterator

addAll

remove

containsAll

removeAll

listIterator

subList

toString

checkRange