Class AbstractReferenceList<K>
- All Implemented Interfaces:
it.unimi.dsi.fastutil.objects.ObjectIterable<K>,ReferenceCollection<K>,ReferenceList<K>,it.unimi.dsi.fastutil.Stack<K>,Iterable<K>,Collection<K>,List<K>,SequencedCollection<K>
- Direct Known Subclasses:
AbstractReferenceList.ReferenceSubList,ReferenceArrayList,ReferenceImmutableList,ReferenceLists.Singleton
As an additional bonus, this class implements on top of the list operations a type-specific stack.
Most of the methods in this class are optimized with the assumption that the List will have
have constant-time random access. If this is not the case, you
should probably at least override listIterator(int) and the xAll() methods
(such as addAll(int, java.util.Collection<? extends K>)) with a more appropriate iteration scheme. Note the subList(int, int)
method is cognizant of random-access or not, so that need not be reimplemented.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classA class implementing a sublist view. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbooleanbooleanaddAll(int index, Collection<? extends K> c) Adds all of the elements in the specified collection to this list (optional operation).booleanaddAll(Collection<? extends K> c) voidaddElements(int index, K[] a) Add (hopefully quickly) elements to this type-specific list.voidaddElements(int index, K[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.voidclear()booleanReturns true if this list contains the specified element.protected voidensureIndex(int index) Ensures that the given index is nonnegative and not greater than the list size.protected voidensureRestrictedIndex(int index) Ensures that the given index is nonnegative and smaller than the list size.booleanvoidvoidgetElements(int from, Object[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.inthashCode()Returns the hash code for this list, which is identical toList.hashCode().intit.unimi.dsi.fastutil.objects.ObjectListIterator<K> iterator()Returns a type-specific iterator on the elements of this collection.intit.unimi.dsi.fastutil.objects.ObjectListIterator<K> Returns a type-specific list iterator on the list.it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.peek(int i) pop()voidremove(int i) voidremoveElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.voidsetElements(int index, K[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.voidsize(int size) Sets the size of this list.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.Object[]toArray()<T> T[]toArray(T[] a) top()toString()Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, remove, removeAll, retainAll, sizeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
addFirst, addLast, containsAll, get, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sizeMethods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceCollection
spliteratorMethods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceList
addAll, addAll, setElements, setElements, sort, spliterator, unstableSortMethods inherited from interface it.unimi.dsi.fastutil.Stack
isEmpty
-
Constructor Details
-
AbstractReferenceList
protected AbstractReferenceList()
-
-
Method Details
-
ensureIndex
protected void ensureIndex(int index) Ensures that the given index is nonnegative and not greater than the list size.- Parameters:
index- an index.- Throws:
IndexOutOfBoundsException- if the given index is negative or greater than the list size.
-
ensureRestrictedIndex
protected void ensureRestrictedIndex(int index) Ensures that the given index is nonnegative and smaller than the list size.- Parameters:
index- an index.- Throws:
IndexOutOfBoundsException- if the given index is negative or not smaller than the list size.
-
add
-
add
- Specified by:
addin interfaceCollection<K>- Specified by:
addin interfaceList<K>- Overrides:
addin classAbstractCollection<K>
-
remove
-
set
-
addAll
Adds all of the elements in the specified collection to this list (optional operation). -
addAll
- Specified by:
addAllin interfaceCollection<K>- Specified by:
addAllin interfaceList<K>- Overrides:
addAllin classAbstractCollection<K>
-
iterator
Returns a type-specific iterator on the elements of this collection.- Specified by:
iteratorin interfaceCollection<K>- Specified by:
iteratorin interfaceIterable<K>- Specified by:
iteratorin interfaceList<K>- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.objects.ObjectIterable<K>- Specified by:
iteratorin interfaceReferenceCollection<K>- Specified by:
iteratorin interfaceReferenceList<K>- Specified by:
iteratorin classAbstractReferenceCollection<K>- Returns:
- a type-specific iterator on the elements of this collection.
-
listIterator
Returns a type-specific list iterator on the list.- Specified by:
listIteratorin interfaceList<K>- Specified by:
listIteratorin interfaceReferenceList<K>- See Also:
-
listIterator
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceList<K>- Specified by:
listIteratorin interfaceReferenceList<K>- See Also:
-
contains
Returns true if this list contains the specified element.- Specified by:
containsin interfaceCollection<K>- Specified by:
containsin interfaceList<K>- Overrides:
containsin classAbstractCollection<K>- See Also:
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceList<K>
-
size
public void size(int size) Description copied from interface:ReferenceListSets the size of this list.If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/
null/false.- Specified by:
sizein interfaceReferenceList<K>- Parameters:
size- the new size.
-
subList
Description copied from interface:ReferenceListReturns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive. -
forEach
-
removeElements
public void removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
removeElementsin interfaceReferenceList<K>- Parameters:
from- the start index (inclusive).to- the end index (exclusive).
-
addElements
Add (hopefully quickly) elements to this type-specific list.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
addElementsin interfaceReferenceList<K>- Parameters:
index- the index at which to add elements.a- the array containing the elements.offset- the offset of the first element to add.length- the number of elements to add.
-
addElements
Add (hopefully quickly) elements to this type-specific list.- Specified by:
addElementsin interfaceReferenceList<K>- Parameters:
index- the index at which to add elements.a- the array containing the elements.
-
getElements
Copies (hopefully quickly) elements of this type-specific list into the given array.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
getElementsin interfaceReferenceList<K>- Parameters:
from- the start index (inclusive).a- the destination array.offset- the offset into the destination array where to store the first element copied.length- the number of elements to be copied.
-
setElements
Description copied from interface:ReferenceListSet (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if byListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.- Specified by:
setElementsin interfaceReferenceList<K>- Parameters:
index- the index at which to start setting elements.a- the array containing the elementsoffset- the offset of the first element to add.length- the number of elements to add.
-
clear
public void clear()- Specified by:
clearin interfaceCollection<K>- Specified by:
clearin interfaceList<K>- Overrides:
clearin classAbstractCollection<K>
-
toArray
- Specified by:
toArrayin interfaceCollection<K>- Specified by:
toArrayin interfaceList<K>- Overrides:
toArrayin classAbstractCollection<K>
-
toArray
public <T> T[] toArray(T[] a) - Specified by:
toArrayin interfaceCollection<K>- Specified by:
toArrayin interfaceList<K>- Overrides:
toArrayin classAbstractCollection<K>
-
hashCode
public int hashCode()Returns the hash code for this list, which is identical toList.hashCode(). -
equals
-
push
- Specified by:
pushin interfaceit.unimi.dsi.fastutil.Stack<K>
-
pop
- Specified by:
popin interfaceit.unimi.dsi.fastutil.Stack<K>
-
top
- Specified by:
topin interfaceit.unimi.dsi.fastutil.Stack<K>
-
peek
- Specified by:
peekin interfaceit.unimi.dsi.fastutil.Stack<K>
-
toString
- Overrides:
toStringin classAbstractReferenceCollection<K>
-