Class ArrayObjectContainerList<E extends NativeObjectContainer>
- java.lang.Object
-
- org.pepstock.charba.client.commons.ArrayObjectContainerList<E>
-
- Type Parameters:
E
- extension ofNativeObjectContainer
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,List<E>
public final class ArrayObjectContainerList<E extends NativeObjectContainer> extends Object
An ordered collection (also known as a sequence). 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 array as back-end to store objects (native object containers).
Elements are instances ofNativeObjectContainer
.
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 java scriptcode.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description ArrayObjectContainerList()
Creates an empty list
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
add(E element)
Appends the specified element to the end of this listboolean
addAll(int index, Collection<? extends E> collection)
void
addAll(E[] values)
Loads an array of elements in the list.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 iteratorprotected 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 elementsIterator<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 listListIterator<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 implementedObject[]
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.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator
-
-
-
-
Method Detail
-
add
public boolean add(E element)
Appends the specified element to the end of this list- Specified by:
add
in interfaceCollection<E extends NativeObjectContainer>
- Specified by:
add
in interfaceList<E extends NativeObjectContainer>
-
clear
public void clear()
Removes all of the elements from this list. The list will be empty after this call returns.- Specified by:
clear
in interfaceCollection<E extends NativeObjectContainer>
- Specified by:
clear
in interfaceList<E extends NativeObjectContainer>
-
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- Specified by:
set
in interfaceList<E extends NativeObjectContainer>
-
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).- Specified by:
add
in interfaceList<E extends NativeObjectContainer>
-
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.- Specified by:
remove
in interfaceList<E extends NativeObjectContainer>
-
addAll
public final void addAll(E[] values)
Loads an array of elements in the list.- Parameters:
values
- an array of elements to be loaded
-
size
public final int size()
Returns the number of elements in this list.- Specified by:
size
in interfaceCollection<E>
- Specified by:
size
in interfaceList<E>
-
isEmpty
public final boolean isEmpty()
Returns true if this list contains no elements- Specified by:
isEmpty
in interfaceCollection<E>
- Specified by:
isEmpty
in interfaceList<E>
-
contains
public final boolean contains(Object object)
Returns true if this list contains the specified element.- Specified by:
contains
in interfaceCollection<E>
- Specified by:
contains
in interfaceList<E>
-
iterator
public final Iterator<E> iterator()
Returns an iterator over the elements in this list in proper sequence.
-
containsAll
public final boolean containsAll(Collection<?> collection)
Returns true if this list contains all of the elements of the specified collection.- Specified by:
containsAll
in interfaceCollection<E>
- Specified by:
containsAll
in interfaceList<E>
-
get
public final E get(int index)
Returns the element at the specified position in this list. If index out of range, returns null
-
indexOf
public final 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 final 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
public final ListIterator<E> listIterator()
Returns a list iterator over the elements in this list- Specified by:
listIterator
in interfaceList<E>
-
listIterator
public final 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 interfaceList<E>
-
subList
public final List<E> subList(int fromIndex, int toIndex)
Not implemented
-
toArray
public final Object[] toArray()
-
toArray
public final <T> T[] toArray(T[] a)
- Specified by:
toArray
in interfaceCollection<E>
- Specified by:
toArray
in interfaceList<E>
-
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
-
addAll
public final boolean addAll(int index, Collection<? extends E> collection)
-
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 interfaceCollection<E>
- Specified by:
remove
in interfaceList<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 interfaceCollection<E>
- Specified by:
removeAll
in interfaceList<E>
-
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
-
-