Interface CharCollection
- All Superinterfaces:
CharIterable,Collection<Character>,Iterable<Character>
- All Known Subinterfaces:
CharList
- All Known Implementing Classes:
AbstractCharCollection,AbstractCharList,AbstractCharList.CharRandomAccessSubList,AbstractCharList.CharSubList,CharArrayList,CharArrayList.SubList,CharCollections.EmptyCollection,CharCollections.IterableCollection,CharImmutableList,CharLists.EmptyList,CharLists.Singleton,CharLists.SynchronizedList,CharLists.SynchronizedRandomAccessList,CharLists.UnmodifiableList,CharLists.UnmodifiableRandomAccessList
Collection; provides some additional methods
that use polymorphism to avoid (un)boxing.
Additionally, this class defines strengthens (again) iterator().
This interface specifies reference equality semantics (members will be compared equal with
== instead of equals), which may result in breaks in contract
if attempted to be used with non reference-equality semantics based Collections. For example, a
aReferenceCollection.equals(aObjectCollection) may return different a different result then
aObjectCollection.equals(aReferenceCollection), in violation of equals's
contract requiring it being symmetric.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(char key) Ensures that this collection contains the specified element (optional operation).default booleanDeprecated.Please use the corresponding type-specific method instead.booleanAdds all elements of the given type-specific collection to this collection.booleancontains(char key) Returnstrueif this collection contains the specified element.default booleanDeprecated.Please use the corresponding type-specific method instead.booleanChecks whether this collection contains all elements from the given type-specific collection.default it.unimi.dsi.fastutil.ints.IntIteratorReturns a widened primitive iterator on the elements of this collection.default IntStreamReturn a parallel primitive stream over the elements, performing widening casts if needed.default it.unimi.dsi.fastutil.ints.IntSpliteratorReturns widened primitive spliterator on the elements of this collection.default IntStreamReturn a primitive stream over the elements, performing widening casts if needed.it.unimi.dsi.fastutil.chars.CharIteratoriterator()Returns a type-specific iterator on the elements of this collection.Deprecated.Please use the corresponding type-specific method instead.booleanrem(char key) Removes a single instance of the specified element from this collection, if it is present (optional operation).default booleanDeprecated.Please use (and implement) therem()method instead.booleanRemove from this collection all elements in the given type-specific collection.default booleanremoveIf(CharPredicate filter) Remove from this collection all elements which satisfy the given predicate.default booleanremoveIf(IntPredicate filter) Remove from this collection all elements which satisfy the given predicate.default booleanDeprecated.Please use the corresponding type-specific method instead.booleanRetains in this collection only elements from the given type-specific collection.default it.unimi.dsi.fastutil.chars.CharSpliteratorReturns a type-specific spliterator on the elements of this collection.stream()Deprecated.Please use the corresponding type-specific method instead.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.default char[]toCharArray(char[] a) Deprecated.Please usetoArray()instead—this method is redundant and will be removed in the future.Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEach, forEach
-
Method Details
-
iterator
it.unimi.dsi.fastutil.chars.CharIterator iterator()Returns a type-specific iterator on the elements of this collection.- Specified by:
iteratorin interfaceCharIterable- Specified by:
iteratorin interfaceCollection<Character>- Specified by:
iteratorin interfaceIterable<Character>- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
-
intIterator
default it.unimi.dsi.fastutil.ints.IntIterator intIterator()Returns a widened primitive iterator on the elements of this collection.This method is provided for the purpose of APIs that expect only the JDK's primitive iterators, of which there are only
int,long, anddouble.WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs
(int)(charValue)casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. SeeCharacterfor more discussion on code points, char values, and surrogate pairs.- Specified by:
intIteratorin interfaceCharIterable- Returns:
- a widened primitive iterator on the elements of this collection.
- Since:
- 8.5.0
-
spliterator
default it.unimi.dsi.fastutil.chars.CharSpliterator spliterator()Returns a type-specific spliterator on the elements of this collection.See
Collection.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceCharIterable- Specified by:
spliteratorin interfaceCollection<Character>- Specified by:
spliteratorin interfaceIterable<Character>- Returns:
- a type-specific spliterator on the elements of this collection.
- Since:
- 8.5.0
-
intSpliterator
default it.unimi.dsi.fastutil.ints.IntSpliterator intSpliterator()Returns widened primitive spliterator on the elements of this collection.This method is provided for the purpose of APIs that expect only the JDK's primitive spliterators, of which there are only
int,long, anddouble.WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs
(int)(charValue)casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. SeeCharacterfor more discussion on code points, char values, and surrogate pairs.- Specified by:
intSpliteratorin interfaceCharIterable- Returns:
- a widened primitive spliterator on the elements of this collection.
- Since:
- 8.5.0
-
add
boolean add(char key) Ensures that this collection contains the specified element (optional operation).- See Also:
-
contains
boolean contains(char key) Returnstrueif this collection contains the specified element.- See Also:
-
rem
boolean rem(char key) Removes a single instance of the specified element from this collection, if it is present (optional operation).Note that this method should be called
remove(), but the clash with the similarly named index-based method in theListinterface forces us to use a distinguished name. For simplicity, the set interfaces reinstatesremove().- See Also:
-
add
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
addin interfaceCollection<Character>
-
contains
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsin interfaceCollection<Character>
-
remove
Deprecated.Please use (and implement) therem()method instead.- Specified by:
removein interfaceCollection<Character>
-
toCharArray
char[] toCharArray()Returns a primitive type array containing the items of this collection.- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toCharArray
Deprecated.Please usetoArray()instead—this method is redundant and will be removed in the future.Returns a primitive type array containing the items of this collection.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.- 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:
-
toArray
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.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.- 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:
-
addAll
Adds all elements of the given type-specific collection to this collection.- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
containsAll
Checks whether this collection contains all elements from the given type-specific collection.- Parameters:
c- a type-specific collection.- Returns:
trueif this collection contains all elements of the argument.- See Also:
-
removeAll
Remove from this collection all elements in the given type-specific collection.- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
removeIf
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
removeIfin interfaceCollection<Character>
-
removeIf
Remove from this collection all elements which satisfy the given predicate.- Parameters:
filter- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
-
removeIf
Remove from this collection all elements which satisfy the given predicate.- Parameters:
filter- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
-
retainAll
Retains in this collection only elements from the given type-specific collection.- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
stream
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
streamin interfaceCollection<Character>
-
intStream
Return a primitive stream over the elements, performing widening casts if needed.WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs
(int)(charValue)casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. SeeCharacterfor more discussion on code points, char values, and surrogate pairs.- Returns:
- a primitive stream over the elements.
- See Also:
-
parallelStream
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
parallelStreamin interfaceCollection<Character>
-
intParallelStream
Return a parallel primitive stream over the elements, performing widening casts if needed.WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs
(int)(charValue)casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. SeeCharacterfor more discussion on code points, char values, and surrogate pairs.- Returns:
- a parallel primitive stream over the elements.
- See Also:
-