it.unimi.dsi.fastutil.chars

Class CharLists.Singleton

java.lang.Object

java.util.AbstractCollection<Character>

it.unimi.dsi.fastutil.chars.AbstractCharCollection

it.unimi.dsi.fastutil.chars.AbstractCharList

it.unimi.dsi.fastutil.chars.CharLists.Singleton

All Implemented Interfaces:

CharCollection, CharIterable, CharList, CharStack, Stack<Character>, Serializable, Cloneable, Comparable<List<? extends Character>>, Iterable<Character>, Collection<Character>, List<Character>, RandomAccess

Enclosing class:

CharLists

public static class CharLists.Singleton
extends AbstractCharList
implements RandomAccess, Serializable, Cloneable

An immutable class representing a type-specific singleton list.

This class may be useful to implement your own in case you subclass a type-specific list.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList

AbstractCharList.CharSubList

Method Summary

Modifier and Type	Method and Description
boolean	addAll(CharCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(CharList c) Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
boolean	addAll(Collection<? extends Character> c) Adds all of the elements in the specified collection to this collection (optional operation).
boolean	addAll(int i, CharCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
boolean	addAll(int i, CharList c) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
boolean	addAll(int i, Collection<? extends Character> c) Adds all of the elements in the specified collection to this list (optional operation).
void	clear() Removes all of the elements from this collection (optional operation).
Object	clone() Creates and returns a copy of this object.
boolean	contains(char k) Returns true if this list contains the specified element.
char	getChar(int i) Returns the element at the specified position in this list.
CharListIterator	iterator() Returns an iterator over the elements contained in this collection.
CharListIterator	listIterator() Returns a type-specific list iterator on the list.
CharListIterator	listIterator(int i) Returns a type-specific list iterator on the list starting at a given index.
boolean	rem(char k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(CharCollection c) Remove from this collection all elements in the given type-specific collection.
boolean	removeAll(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
char	removeChar(int i) Removes the element at the specified position in this list (optional operation).
boolean	retainAll(CharCollection c) Retains in this collection only elements from the given type-specific collection.
boolean	retainAll(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this collection.
void	size(int size) Sets the size of this list.
CharList	subList(int from, int to) Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
char[]	toCharArray() Returns a primitive type array containing the items of this collection.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList

add, add, add, addElements, addElements, compareTo, equals, get, getElements, hashCode, indexOf, indexOf, lastIndexOf, lastIndexOf, peek, peekChar, pop, popChar, push, push, remove, removeElements, set, set, top, topChar, toString

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

add, contains, containsAll, remove, toArray, toCharArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharList

add

Methods inherited from interface java.util.List

contains, containsAll, isEmpty, remove, replaceAll, sort, spliterator, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection

contains, containsAll, remove, toArray, toCharArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.Stack

isEmpty

Method Detail

getChar

public char getChar(int i)

Description copied from interface: CharList

Returns the element at the specified position in this list.

Specified by:

getChar in interface CharList

See Also:

List.get(int)

rem

public boolean rem(char k)

Description copied from class: AbstractCharList

Removes a single instance of the specified element from this collection, if it is present (optional operation).

This implementation delegates to indexOf().

Specified by:

rem in interface CharCollection

Overrides:

rem in class AbstractCharList

See Also:

List.remove(Object)

removeChar

public char removeChar(int i)

Description copied from class: AbstractCharList

Removes the element at the specified position in this list (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

removeChar in interface CharList

Overrides:

removeChar in class AbstractCharList

See Also:

List.remove(int)

contains

public boolean contains(char k)

Description copied from class: AbstractCharList

Returns true if this list contains the specified element.

This implementation delegates to indexOf().

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharList

See Also:

List.contains(Object)

toCharArray

public char[] toCharArray()

Description copied from interface: CharCollection

Returns a primitive type array containing the items of this collection.

Specified by:

toCharArray in interface CharCollection

Overrides:

toCharArray in class AbstractCharCollection

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray()

listIterator

public CharListIterator listIterator()

Description copied from class: AbstractCharList

Returns a type-specific list iterator on the list.

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface CharList

Specified by:

listIterator in interface List<Character>

Overrides:

listIterator in class AbstractCharList

Returns:

a list iterator over the elements in this list (in proper sequence)

See Also:

List.listIterator()

iterator

public CharListIterator iterator()

Description copied from class: AbstractCharList

Returns an iterator over the elements contained in this collection.

This implementation delegates to AbstractCharList.listIterator().

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharList

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in interface Collection<Character>

Specified by:

iterator in interface List<Character>

Overrides:

iterator in class AbstractCharList

Returns:

an iterator over the elements contained in this collection

See Also:

Iterable.iterator()

listIterator

public CharListIterator listIterator(int i)

Description copied from class: AbstractCharList

Returns a type-specific list iterator on the list starting at a given index.

This implementation is based on the random-access methods.

Specified by:

listIterator in interface CharList

Specified by:

listIterator in interface List<Character>

Overrides:

listIterator in class AbstractCharList

Parameters:

i - index of the first element to be returned from the list iterator (by a call to next)

Returns:

a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

See Also:

List.listIterator(int)

subList

public CharList subList(int from,
                        int to)

Description copied from interface: CharList

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:

subList in interface CharList

Specified by:

subList in interface List<Character>

Overrides:

subList in class AbstractCharList

Parameters:

from - low endpoint (inclusive) of the subList

to - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this list

See Also:

List.subList(int,int)

addAll

public boolean addAll(int i,
                      Collection<? extends Character> c)

Description copied from class: AbstractCharList

Adds all of the elements in the specified collection to this list (optional operation).

Specified by:

addAll in interface List<Character>

Overrides:

addAll in class AbstractCharList

Parameters:

i - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(Collection<? extends Character> c)

Description copied from class: AbstractCharList

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn.

Note that this implementation will throw an UnsupportedOperationException unless add is overridden (assuming the specified collection is non-empty).

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface Collection<Character>

Specified by:

addAll in interface List<Character>

Overrides:

addAll in class AbstractCharList

Parameters:

c - collection containing elements to be added to this collection

Returns:

true if this collection changed as a result of the call

See Also:

AbstractCollection.add(Object)

removeAll

public boolean removeAll(Collection<?> c)

Description copied from class: java.util.AbstractCollection

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.

Specified by:

removeAll in interface Collection<Character>

Specified by:

removeAll in interface List<Character>

Overrides:

removeAll in class AbstractCollection<Character>

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

See Also:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

Description copied from class: java.util.AbstractCollection

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection.

Specified by:

retainAll in interface Collection<Character>

Specified by:

retainAll in interface List<Character>

Overrides:

retainAll in class AbstractCollection<Character>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

See Also:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)

addAll

public boolean addAll(CharList c)

Description copied from class: AbstractCharList

Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).

This implementation delegates to the type-specific list version of List.addAll(int, Collection).

Specified by:

addAll in interface CharList

Overrides:

addAll in class AbstractCharList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int i,
                      CharList c)

Description copied from class: AbstractCharList

Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface CharList

Overrides:

addAll in class AbstractCharList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int i,
                      CharCollection c)

Description copied from interface: CharList

Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).

Specified by:

addAll in interface CharList

Overrides:

addAll in class AbstractCharList

See Also:

List.addAll(int,java.util.Collection)

addAll

public boolean addAll(CharCollection c)

Description copied from class: AbstractCharList

Adds all elements of the given type-specific collection to this collection.

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface CharCollection

Overrides:

addAll in class AbstractCharList

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.addAll(Collection)

removeAll

public boolean removeAll(CharCollection c)

Description copied from interface: CharCollection

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface CharCollection

Overrides:

removeAll in class AbstractCharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(CharCollection c)

Description copied from interface: CharCollection

Retains in this collection only elements from the given type-specific collection.

Specified by:

retainAll in interface CharCollection

Overrides:

retainAll in class AbstractCharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.retainAll(Collection)

size

public int size()

Description copied from interface: java.util.Collection

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection<Character>

Specified by:

size in interface List<Character>

Specified by:

size in class AbstractCollection<Character>

Returns:

the number of elements in this collection

size

public void size(int size)

Description copied from interface: CharList

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 interface CharList

Overrides:

size in class AbstractCharList

Parameters:

size - the new size.

clear

public void clear()

Description copied from class: AbstractCharList

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

This implementation delegates to AbstractCharList.removeElements(int, int).

Specified by:

clear in interface Collection<Character>

Specified by:

clear in interface List<Character>

Overrides:

clear in class AbstractCharList

clone

public Object clone()

Description copied from class: java.lang.Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable