Class CharImmutableList
- All Implemented Interfaces:
CharCollection,CharIterable,CharList,CharStack,Stack<Character>,Serializable,Cloneable,Comparable<List<? extends Character>>,Iterable<Character>,Collection<Character>,List<Character>,RandomAccess
Instances of this class are immutable and (contrarily to mutable array-based list implementations) the backing array is not exposed. Instances can be built using a variety of methods, but note that constructors using an array will not make a defensive copy.
This class implements the bulk method getElements() using high-performance system calls
(e.g., System.arraycopy()) instead of
expensive loops.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList
AbstractCharList.CharRandomAccessSubList, AbstractCharList.CharSubList -
Constructor Summary
ConstructorsConstructorDescriptionCharImmutableList(char[] a) Creates a new immutable list using a given array.CharImmutableList(char[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.Creates a new immutable list and fills it with a given type-specific collection.Creates a new immutable list and fills it with the elements returned by a type-specific iterator..Creates a new immutable list and fills it with a given type-specific list.CharImmutableList(Collection<? extends Character> c) Creates a new immutable list and fills it with a given collection. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanadd(char k) Deprecated.final voidadd(int index, char k) Deprecated.final voidDeprecated.final booleanDeprecated.final booleanaddAll(int index, CharCollection c) Deprecated.final booleanDeprecated.final booleanaddAll(int index, Collection<? extends Character> c) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanaddAll(Collection<? extends Character> c) Deprecated.final voidaddElements(int index, char[] a, int offset, int length) Deprecated.final voidclear()Deprecated.clone()intCompares this immutable list to another immutable list.intCompares this list to another object.booleanCompares this type-specific immutable list to another one.booleanvoidforEach(CharConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.chargetChar(int index) Returns the element at the specified position in this list.voidgetElements(int from, char[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intindexOf(char k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.booleanisEmpty()Checks whether the stack is empty.intlastIndexOf(char k) 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(int index) Returns a type-specific list iterator on the list starting at a given index.static CharImmutableListof()Returns an empty immutable list.static CharImmutableListof(char... init) Creates an immutable list using a list of elements.final booleanrem(char k) Deprecated.final Characterremove(int index) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanremoveAll(Collection<?> c) Deprecated.final charremoveChar(int index) Deprecated.final voidremoveElements(int from, int to) Deprecated.final booleanDeprecated.final booleanDeprecated.final voidreplaceAll(IntUnaryOperator operator) Deprecated.final voidreplaceAll(UnaryOperator<Character> operator) Deprecated.final booleanDeprecated.final booleanretainAll(Collection<?> c) Deprecated.final charset(int index, char k) Deprecated.final CharacterDeprecated.final voidsetElements(int index, char[] a, int offset, int length) Deprecated.intsize()final voidsize(int size) Deprecated.final voidsort(CharComparator comp) Deprecated.final voidsort(Comparator<? super Character> comparator) Deprecated.Returns a type-specific spliterator on the elements 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.char[]toArray(char[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.char[]Returns a primitive type array containing the items of this collection.final voidunstableSort(CharComparator comp) Deprecated.final voidunstableSort(Comparator<? super Character> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList
addElements, contains, hashCode, iterator, listIterator, peekChar, popChar, push, topChar, toStringMethods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
contains, containsAll, containsAll, toCharArrayMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, rem, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toCharArrayMethods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.chars.CharList
add, add, add, add, addAll, addAll, addAll, addElements, addElements, contains, get, indexOf, iterator, lastIndexOf, listIterator, remove, remove, removeChar, removeElements, replaceAll, replaceAll, replaceAll, set, set, setElements, setElements, setElements, size, sort, sort, unstableSort, unstableSortMethods inherited from interface java.util.Collection
toArray
-
Constructor Details
-
CharImmutableList
public CharImmutableList(char[] a) Creates a new immutable list using a given array.Note that this constructor does not perform a defensive copy.
- Parameters:
a- the array that will be used to back this immutable list.
-
CharImmutableList
Creates a new immutable list and fills it with a given collection.- Parameters:
c- a collection that will be used to fill the immutable list.
-
CharImmutableList
Creates a new immutable list and fills it with a given type-specific collection.- Parameters:
c- a type-specific collection that will be used to fill the immutable list.
-
CharImmutableList
Creates a new immutable list and fills it with a given type-specific list.- Parameters:
l- a type-specific list that will be used to fill the immutable list.
-
CharImmutableList
public CharImmutableList(char[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.- Parameters:
a- an array whose elements will be used to fill the immutable list.offset- the first element to use.length- the number of elements to use.
-
CharImmutableList
Creates a new immutable list and fills it with the elements returned by a type-specific iterator..- Parameters:
i- a type-specific iterator whose returned elements will fill the immutable list.
-
-
Method Details
-
of
Returns an empty immutable list.- Returns:
- an immutable list (possibly shared) that is empty.
-
of
Creates an immutable list using a list of elements.Note that this method does not perform a defensive copy.
- Parameters:
init- a list of elements that will be used to initialize the list.- Returns:
- a new immutable list containing the given elements.
-
getChar
public char getChar(int index) Description copied from interface:CharListReturns the element at the specified position in this list. -
indexOf
public int indexOf(char k) Description copied from interface:CharListReturns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOfin interfaceCharList- Overrides:
indexOfin classAbstractCharList- See Also:
-
lastIndexOf
public int lastIndexOf(char k) Description copied from interface:CharListReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOfin interfaceCharList- Overrides:
lastIndexOfin classAbstractCharList- See Also:
-
size
public int size()- Specified by:
sizein interfaceCollection<Character>- Specified by:
sizein interfaceList<Character>- Specified by:
sizein classAbstractCollection<Character>
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
getElements
public void getElements(int from, char[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceCharList- Overrides:
getElementsin classAbstractCharList- 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.
-
forEach
Description copied from class:AbstractCharListPerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceCharIterable- Overrides:
forEachin classAbstractCharList- Parameters:
action- the action to be performed for each element.- See Also:
-
toCharArray
public char[] toCharArray()Description copied from interface:CharCollectionReturns a primitive type array containing the items of this collection.- Specified by:
toCharArrayin interfaceCharCollection- Overrides:
toCharArrayin classAbstractCharList- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public char[] toArray(char[] a) Description copied from interface:CharCollectionReturns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.Note that, contrarily to
Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.- Specified by:
toArrayin interfaceCharCollection- Overrides:
toArrayin classAbstractCharList- Parameters:
a- if this array is big enough, it will be used to store this collection.- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
listIterator
Description copied from class:AbstractCharListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceCharList- Specified by:
listIteratorin interfaceList<Character>- Overrides:
listIteratorin classAbstractCharList- See Also:
-
spliterator
Description copied from interface:CharListReturns a type-specific spliterator on the elements of this list.List spliterators must report at least
Spliterator.SIZEDandSpliterator.ORDERED.See
List.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceCharCollection- Specified by:
spliteratorin interfaceCharIterable- Specified by:
spliteratorin interfaceCharList- Specified by:
spliteratorin interfaceCollection<Character>- Specified by:
spliteratorin interfaceIterable<Character>- Specified by:
spliteratorin interfaceList<Character>- Returns:
- a type-specific spliterator on the elements of this collection.
-
subList
Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.- Specified by:
subListin interfaceCharList- Specified by:
subListin interfaceList<Character>- Overrides:
subListin classAbstractCharList- See Also:
- API Notes:
- The returned list will be immutable, but is currently not declared to return an instance
of
ImmutableListdue to complications of implementation details. This may change in a future version (in other words, do not consider the return type of this method to be stable if making a subclass ofImmutableList).
-
clone
-
equals
Compares this type-specific immutable list to another one.- Parameters:
l- a type-specific immutable list.- Returns:
- true if the argument contains the same elements of this type-specific immutable list.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
equals
- Specified by:
equalsin interfaceCollection<Character>- Specified by:
equalsin interfaceList<Character>- Overrides:
equalsin classAbstractCharList
-
compareTo
Compares this immutable list to another immutable list.- Parameters:
l- an immutable list.- Returns:
- a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
compareTo
Description copied from class:AbstractCharListCompares this list to another object. If the argument is aList, this method performs a lexicographical comparison; otherwise, it throws aClassCastException.- Specified by:
compareToin interfaceComparable<List<? extends Character>>- Overrides:
compareToin classAbstractCharList- Parameters:
l- a list.- Returns:
- if the argument is a
List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
-
add
Deprecated.Description copied from class:AbstractCharListInserts the specified element at the specified position in this list (optional operation).- Specified by:
addin interfaceCharList- Overrides:
addin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractCharListEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceCharCollection- Specified by:
addin interfaceCharList- Overrides:
addin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractCharList- Specified by:
addAllin interfaceCollection<Character>- Specified by:
addAllin interfaceList<Character>- Overrides:
addAllin classAbstractCharList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractCharListAdds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAllin interfaceList<Character>- Overrides:
addAllin classAbstractCharList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeChar
Deprecated.Description copied from class:AbstractCharListRemoves the element at the specified position in this list (optional operation).- Specified by:
removeCharin interfaceCharList- Overrides:
removeCharin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractCharListRemoves a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
remin interfaceCharCollection- Overrides:
remin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractCharCollection- Specified by:
removeAllin interfaceCollection<Character>- Specified by:
removeAllin interfaceList<Character>- Overrides:
removeAllin classAbstractCharCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractCharCollection- Specified by:
retainAllin interfaceCollection<Character>- Specified by:
retainAllin interfaceList<Character>- Overrides:
retainAllin classAbstractCharCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:CharCollection- Specified by:
removeIfin interfaceCharCollection- Specified by:
removeIfin interfaceCollection<Character>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:CharCollectionRemove from this collection all elements which satisfy the given predicate.- Specified by:
removeIfin interfaceCharCollection- Parameters:
c- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:CharList- Specified by:
replaceAllin interfaceCharList- Specified by:
replaceAllin interfaceList<Character>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:CharListReplaces each element of this list with the result of applying the operator to that element, performing widening and narrowing primitive casts, until all elements have been processed or the action throws an exception.- Specified by:
replaceAllin interfaceCharList- Parameters:
operator- the operator to apply to each element- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from interface:CharList -
add
Deprecated.Description copied from class:AbstractCharCollection- Specified by:
addin interfaceCharCollection- Specified by:
addin interfaceCharList- Specified by:
addin interfaceCollection<Character>- Specified by:
addin interfaceList<Character>- Overrides:
addin classAbstractCharCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from interface:CharList -
remove
Deprecated.Description copied from class:AbstractCharCollection- Specified by:
removein interfaceCharCollection- Specified by:
removein interfaceCharList- Specified by:
removein interfaceCollection<Character>- Specified by:
removein interfaceList<Character>- Overrides:
removein classAbstractCharCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from interface:CharList -
addAll
Deprecated.Description copied from class:AbstractCharListAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceCharCollection- Overrides:
addAllin classAbstractCharList- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:CharListAppends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAllin interfaceCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:CharListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceCharList- Overrides:
addAllin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:CharListInserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:CharCollectionRemove from this collection all elements in the given type-specific collection.- Specified by:
removeAllin interfaceCharCollection- Overrides:
removeAllin classAbstractCharCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from interface:CharCollectionRetains in this collection only elements from the given type-specific collection.- Specified by:
retainAllin interfaceCharCollection- Overrides:
retainAllin classAbstractCharCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractCharListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceCharList- Overrides:
setin classAbstractCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractCharList- Specified by:
clearin interfaceCollection<Character>- Specified by:
clearin interfaceList<Character>- Overrides:
clearin classAbstractCharList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
size
Deprecated.Description copied from interface:CharListSets 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 interfaceCharList- Overrides:
sizein classAbstractCharList- Parameters:
size- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractCharListRemoves (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 interfaceCharList- Overrides:
removeElementsin classAbstractCharList- Parameters:
from- the start index (inclusive).to- the end index (exclusive).- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addElements
Deprecated.Description copied from class:AbstractCharListAdd (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 interfaceCharList- Overrides:
addElementsin classAbstractCharList- 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.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
setElements
Deprecated.Description copied from interface:CharListSet (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 interfaceCharList- Overrides:
setElementsin classAbstractCharList- 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.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:CharListSort a list using a type-specific comparator.Pass
nullto sort using natural ordering.- Specified by:
sortin interfaceCharList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:CharListSorts this list using a sort not assured to be stable.Pass
nullto sort using natural ordering.This differs from
List.sort(java.util.Comparator)in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Specified by:
unstableSortin interfaceCharList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:CharList -
unstableSort
Deprecated.Description copied from interface:CharListSorts this list using a sort not assured to be stable.- Specified by:
unstableSortin interfaceCharList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-