Class AbstractReferenceList<K>
- All Implemented Interfaces:
ObjectIterable<K>
,ReferenceCollection<K>
,ReferenceList<K>
,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
Modifier and TypeClassDescriptionstatic class
static class
A class implementing a sublist view. -
Method Summary
Modifier and TypeMethodDescriptionvoid
boolean
boolean
addAll
(int index, Collection<? extends K> c) Adds all of the elements in the specified collection to this list (optional operation).boolean
addAll
(Collection<? extends K> c) void
addElements
(int index, K[] a) Add (hopefully quickly) elements to this type-specific list.void
addElements
(int index, K[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.void
clear()
boolean
Returns true if this list contains the specified element.boolean
void
void
getElements
(int from, Object[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.int
hashCode()
Returns the hash code for this list, which is identical toList.hashCode()
.int
iterator()
Returns a type-specific iterator on the elements of this collection.int
Returns a type-specific list iterator on the list.listIterator
(int index) Returns a type-specific list iterator on the list starting at a given index.peek
(int i) Peeks at an element on the stack (optional operation).pop()
Pops the top off the stack.void
Pushes the given object on the stack.remove
(int i) void
removeElements
(int from, int to) Removes (hopefully quickly) elements of this type-specific list.void
setElements
(int index, K[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.void
size
(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()
Peeks at the top of the stack (optional operation).toString()
Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, remove, removeAll, retainAll, size
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface java.util.List
addFirst, addLast, containsAll, get, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, size
Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceCollection
spliterator
Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceList
addAll, addAll, setElements, setElements, sort, spliterator, unstableSort
-
Method Details
-
add
- Specified by:
add
in interfaceList<K>
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
add
- Specified by:
add
in interfaceCollection<K>
- Specified by:
add
in interfaceList<K>
- Overrides:
add
in classAbstractCollection<K>
- Implementation Specification:
- This implementation delegates to the type-specific version of
List.add(int, Object)
.
-
remove
- Specified by:
remove
in interfaceList<K>
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
set
- Specified by:
set
in interfaceList<K>
- Implementation Specification:
- This implementation always throws an
UnsupportedOperationException
.
-
addAll
Adds all of the elements in the specified collection to this list (optional operation). -
addAll
- Specified by:
addAll
in interfaceCollection<K>
- Specified by:
addAll
in interfaceList<K>
- Overrides:
addAll
in classAbstractCollection<K>
- Implementation Specification:
- This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.
-
iterator
Returns a type-specific iterator on the elements of this collection.- Specified by:
iterator
in interfaceCollection<K>
- Specified by:
iterator
in interfaceIterable<K>
- Specified by:
iterator
in interfaceList<K>
- Specified by:
iterator
in interfaceObjectIterable<K>
- Specified by:
iterator
in interfaceReferenceCollection<K>
- Specified by:
iterator
in interfaceReferenceList<K>
- Specified by:
iterator
in classAbstractReferenceCollection<K>
- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
- Implementation Specification:
- This implementation delegates to
listIterator()
.
-
listIterator
Returns a type-specific list iterator on the list.- Specified by:
listIterator
in interfaceList<K>
- Specified by:
listIterator
in interfaceReferenceList<K>
- See Also:
- Implementation Specification:
- This implementation delegates to
listIterator(0)
.
-
listIterator
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceList<K>
- Specified by:
listIterator
in interfaceReferenceList<K>
- See Also:
- Implementation Specification:
- This implementation is based on the random-access methods.
-
contains
Returns true if this list contains the specified element.- Specified by:
contains
in interfaceCollection<K>
- Specified by:
contains
in interfaceList<K>
- Overrides:
contains
in classAbstractCollection<K>
- See Also:
- Implementation Specification:
- This implementation delegates to
indexOf()
.
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceList<K>
-
size
public void size(int size) Description copied from interface:ReferenceList
Sets 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:
size
in interfaceReferenceList<K>
- Parameters:
size
- the new size.
-
subList
Description copied from interface:ReferenceList
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive. -
forEach
- Specified by:
forEach
in interfaceIterable<K>
- Implementation Specification:
- If this list is
RandomAccess
, will iterate using a for loop and the type-specificList.get(int)
method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.
-
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:
removeElements
in 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:
addElements
in 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:
addElements
in interfaceReferenceList<K>
- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.- Implementation Specification:
- This implementation delegates to the analogous method for array fragments.
-
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:
getElements
in 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:ReferenceList
Set (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:
setElements
in 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:
clear
in interfaceCollection<K>
- Specified by:
clear
in interfaceList<K>
- Overrides:
clear
in classAbstractCollection<K>
- Implementation Specification:
- This implementation delegates to
removeElements(int, int)
.
-
toArray
- Specified by:
toArray
in interfaceCollection<K>
- Specified by:
toArray
in interfaceList<K>
- Overrides:
toArray
in classAbstractCollection<K>
-
toArray
public <T> T[] toArray(T[] a) - Specified by:
toArray
in interfaceCollection<K>
- Specified by:
toArray
in interfaceList<K>
- Overrides:
toArray
in classAbstractCollection<K>
-
hashCode
public int hashCode()Returns the hash code for this list, which is identical toList.hashCode()
. -
equals
-
push
Description copied from interface:Stack
Pushes the given object on the stack. -
pop
Description copied from interface:Stack
Pops the top off the stack. -
top
Description copied from interface:Stack
Peeks at the top of the stack (optional operation).This default implementation returns
peek(0)
. -
peek
Description copied from interface:Stack
Peeks at an element on the stack (optional operation).This default implementation just throws an
UnsupportedOperationException
. -
toString
- Overrides:
toString
in classAbstractReferenceCollection<K>
-