CharArrayList (HPPC v0.7.2 API Documentation)

java.lang.Object
- com.carrotsearch.hppc.CharArrayList

All Implemented Interfaces:

CharCollection, CharContainer, CharIndexedContainer, Preallocable, java.lang.Cloneable, java.lang.Iterable<CharCursor>, java.util.RandomAccess

Direct Known Subclasses:

CharStack
```
@Generated(date="2016-10-25T13:31:55+0200",
           value="KTypeArrayList.java")
public class CharArrayList
extends java.lang.Object
implements CharIndexedContainer, Preallocable, java.lang.Cloneable
```
An array-backed list of chars.

Field Summary

Fields
Modifier and Type	Field and Description
`char[]`	`buffer` Internal array for storing the list.
`int`	`elementsCount` Current number of elements stored in `buffer`.
`static char[]`	`EMPTY_ARRAY` An immutable empty buffer (array).
`protected ArraySizingStrategy`	`resizer` Buffer resizing strategy.

Constructor Summary

Constructors
Constructor and Description
`CharArrayList()` New instance with sane defaults.
`CharArrayList(CharContainer container)` Creates a new list from the elements of another container in its iteration order.
`CharArrayList(int expectedElements)` New instance with sane defaults.
`CharArrayList(int expectedElements, ArraySizingStrategy resizer)` New instance with sane defaults.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(char... elements)` Vararg-signature method for adding elements at the end of the list.
`void`	`add(char e1)` Adds an element to the end of this container (the last index is incremented by one).
`void`	`add(char[] elements, int start, int length)` Add all elements from a range of given array to the list.
`void`	`add(char e1, char e2)` Appends two elements at the end of the list.
`int`	`addAll(CharContainer container)` Adds all elements from another container.
`int`	`addAll(java.lang.Iterable<? extends CharCursor> iterable)` Adds all elements from another iterable.
`void`	`clear()` Sets the number of stored elements to zero.
`CharArrayList`	`clone()` Clone this object.
`boolean`	`contains(char e1)` Lookup a given element in the container.
`protected void`	`ensureBufferSpace(int expectedAdditions)` Ensures the internal buffer has enough free slots to store `expectedAdditions`.
`void`	`ensureCapacity(int expectedElements)` Ensure this container can hold at least the given number of elements without resizing its buffers.
`protected boolean`	`equalElements(CharArrayList other)` Compare index-aligned elements against another `CharIndexedContainer`.
`boolean`	`equals(java.lang.Object obj)` Returns `true` only if the other object is an instance of the same class and with the same elements.
`<T extends CharPredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements as long, as the predicate returns `true`.
`<T extends CharProcedure> T`	`forEach(T procedure)` Applies a `procedure` to all container elements.
`<T extends CharPredicate> T`	`forEach(T predicate, int fromIndex, int toIndex)` Applies `predicate` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive, or until predicate returns `false`.
`<T extends CharProcedure> T`	`forEach(T procedure, int fromIndex, int toIndex)` Applies `procedure` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive.
`static CharArrayList`	`from(char... elements)` Create a list from a variable number of arguments or an array of `char`.
`char`	`get(int index)`
`int`	`hashCode()`
`int`	`indexOf(char e1)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`void`	`insert(int index, char e1)` Inserts the specified element at the specified position in this list.
`boolean`	`isEmpty()` Shortcut for `size() == 0`.
`java.util.Iterator<CharCursor>`	`iterator()` Returns an iterator to a cursor traversing the collection.
`int`	`lastIndexOf(char e1)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`void`	`release()` Sets the number of stored elements to zero and releases the internal storage array.
`char`	`remove(int index)` Removes the element at the specified position in this container and returns it.
`int`	`removeAll(char e1)` Removes all occurrences of `e` from this collection.
`int`	`removeAll(CharLookupContainer c)` Default implementation uses a predicate for removal.
`int`	`removeAll(CharPredicate predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`int`	`removeFirst(char e1)` Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`int`	`removeLast(char e1)` Removes the last element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`void`	`removeRange(int fromIndex, int toIndex)` Removes from this container all of the elements with indexes between `fromIndex`, inclusive, and `toIndex`, exclusive.
`void`	`resize(int newSize)` Truncate or expand the list to the new size.
`int`	`retainAll(CharLookupContainer c)` Default implementation uses a predicate for retaining.
`int`	`retainAll(CharPredicate predicate)` Default implementation redirects to `CharCollection.removeAll(CharPredicate)` and negates the predicate.
`char`	`set(int index, char e1)` Replaces the element at the specified position in this list with the specified element.
`int`	`size()` Return the current number of elements in this container.
`char[]`	`toArray()` Default implementation of copying to an array.
`java.lang.String`	`toString()` Convert the contents of this container to a human-friendly string.
`void`	`trimToSize()` Trim the internal buffer to the current size.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppc.CharCollection
removeAll, retainAll, retainAll

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - EMPTY_ARRAY
```
public static final char[] EMPTY_ARRAY
```
    An immutable empty buffer (array).
  - buffer
```
public char[] buffer
```
    Internal array for storing the list. The array may be larger than the current size (size()).
  - elementsCount
```
public int elementsCount
```
    Current number of elements stored in buffer.
  - resizer
```
protected final ArraySizingStrategy resizer
```
    Buffer resizing strategy.
- Constructor Detail
  - CharArrayList
```
public CharArrayList()
```
    New instance with sane defaults.
  - CharArrayList
```
public CharArrayList(int expectedElements)
```
    New instance with sane defaults.
    
    Parameters:
    
    expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
  - CharArrayList
```
public CharArrayList(int expectedElements,
                     ArraySizingStrategy resizer)
```
    New instance with sane defaults.
    
    Parameters:
    
    expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
    
    resizer - Underlying buffer sizing strategy.
  - CharArrayList
```
public CharArrayList(CharContainer container)
```
    Creates a new list from the elements of another container in its iteration order.
- Method Detail
  - add
```
public void add(char e1)
```
    Adds an element to the end of this container (the last index is incremented by one).
    
    Specified by:
    
    add in interface CharIndexedContainer
  - add
```
public void add(char e1,
                char e2)
```
    Appends two elements at the end of the list. To add more than two elements, use add (vararg-version) or access the buffer directly (tight loop).
  - add
```
public void add(char[] elements,
                int start,
                int length)
```
    Add all elements from a range of given array to the list.
  - add
```
public final void add(char... elements)
```
    Vararg-signature method for adding elements at the end of the list.
    This method is handy, but costly if used in tight loops (anonymous array passing)
  - addAll
```
public int addAll(CharContainer container)
```
    Adds all elements from another container.
  - addAll
```
public int addAll(java.lang.Iterable<? extends CharCursor> iterable)
```
    Adds all elements from another iterable.
  - insert
```
public void insert(int index,
                   char e1)
```
    Inserts the specified element at the specified position in this list.
    
    Specified by:
    
    insert in interface CharIndexedContainer
    
    Parameters:
    
    index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right.
  - get
```
public char get(int index)
```
    Specified by:
    
    get in interface CharIndexedContainer
    
    Returns:
    
    Returns the element at index index from the list.
  - set
```
public char set(int index,
                char e1)
```
    Replaces the element at the specified position in this list with the specified element.
    
    Specified by:
    
    set in interface CharIndexedContainer
    
    Returns:
    
    Returns the previous value in the list.
  - remove
```
public char remove(int index)
```
    Removes the element at the specified position in this container and returns it.
    
    Specified by:
    
    remove in interface CharIndexedContainer
    
    See Also:
    
    CharIndexedContainer.removeFirst(char), CharIndexedContainer.removeLast(char), CharCollection.removeAll(char)
  - removeRange
```
public void removeRange(int fromIndex,
                        int toIndex)
```
    Removes from this container all of the elements with indexes between fromIndex, inclusive, and toIndex, exclusive.
    
    Specified by:
    
    removeRange in interface CharIndexedContainer
  - removeFirst
```
public int removeFirst(char e1)
```
    Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeFirst in interface CharIndexedContainer
  - removeLast
```
public int removeLast(char e1)
```
    Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeLast in interface CharIndexedContainer
  - removeAll
```
public int removeAll(char e1)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Parameters:
    
    e1 - Element to be removed from this collection, if present.
    
    Returns:
    
    The number of removed elements as a result of this call.
  - contains
```
public boolean contains(char e1)
```
    Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).
    
    Specified by:
    
    contains in interface CharContainer
    
    Returns:
    
    Returns true if this container has an element equal to e.
  - indexOf
```
public int indexOf(char e1)
```
    Returns 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:
    
    indexOf in interface CharIndexedContainer
  - lastIndexOf
```
public int lastIndexOf(char e1)
```
    Returns 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:
    
    lastIndexOf in interface CharIndexedContainer
  - isEmpty
```
public boolean isEmpty()
```
    Shortcut for size() == 0.
    
    Specified by:
    
    isEmpty in interface CharContainer
  - ensureCapacity
```
public void ensureCapacity(int expectedElements)
```
    Ensure this container can hold at least the given number of elements without resizing its buffers.
    
    Specified by:
    
    ensureCapacity in interface Preallocable
    
    Parameters:
    
    expectedElements - The total number of elements, inclusive.
  - ensureBufferSpace
```
protected void ensureBufferSpace(int expectedAdditions)
```
    Ensures the internal buffer has enough free slots to store expectedAdditions. Increases internal buffer size if needed.
  - resize
```
public void resize(int newSize)
```
    Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (use trimToSize() if you need a truncated buffer), but the truncated values will be reset to the default value (zero). If the list is expanded, the elements beyond the current size are initialized with JVM-defaults (zero or null values).
  - size
```
public int size()
```
    Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
    
    Specified by:
    
    size in interface CharContainer
  - trimToSize
```
public void trimToSize()
```
    Trim the internal buffer to the current size.
  - clear
```
public void clear()
```
    Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set the elementsCount field to zero.
    
    Specified by:
    
    clear in interface CharCollection
    
    See Also:
    
    CharCollection.release()
  - release
```
public void release()
```
    Sets the number of stored elements to zero and releases the internal storage array.
    
    Specified by:
    
    release in interface CharCollection
    
    See Also:
    
    CharCollection.clear()
  - toArray
```
public char[] toArray()
```
    Default implementation of copying to an array.
    The returned array is sized to match exactly the number of elements of the stack.
    
    Specified by:
    
    toArray in interface CharContainer
  - clone
```
public CharArrayList clone()
```
    Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
    
    Overrides:
    
    clone in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true only if the other object is an instance of the same class and with the same elements.
    
    Overrides:
    
    equals in class java.lang.Object
  - equalElements
```
protected boolean equalElements(CharArrayList other)
```
    Compare index-aligned elements against another CharIndexedContainer.
  - iterator
```
public java.util.Iterator<CharCursor> iterator()
```
    Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.
    The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.
```
 for (CharCursor<char> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 
```
    Specified by:
    
    iterator in interface CharContainer
    
    Specified by:
    
    iterator in interface java.lang.Iterable<CharCursor>
  - forEach
```
public <T extends CharProcedure> T forEach(T procedure)
```
    Applies a procedure to all container elements. Returns the argument (any subclass of CharProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):
```
 int count = container.forEach(new IntProcedure() {
   int count; // this is a field declaration in an anonymous class.
 
   public void apply(int value) {
     count++;
   }
 }).count;
 
```
    Specified by:
    
    forEach in interface CharContainer
  - forEach
```
public <T extends CharProcedure> T forEach(T procedure,
                                           int fromIndex,
                                           int toIndex)
```
    Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
  - removeAll
```
public int removeAll(CharPredicate predicate)
```
    Removes all elements in this collection for which the given predicate returns true.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Returns:
    
    Returns the number of removed elements.
  - forEach
```
public <T extends CharPredicate> T forEach(T predicate)
```
    Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
    
    Specified by:
    
    forEach in interface CharContainer
  - forEach
```
public <T extends CharPredicate> T forEach(T predicate,
                                           int fromIndex,
                                           int toIndex)
```
    Applies predicate to a slice of the list, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.
  - from
```
public static CharArrayList from(char... elements)
```
    Create a list from a variable number of arguments or an array of char. The elements are copied from the argument to the internal buffer.
  - removeAll
```
public int removeAll(CharLookupContainer c)
```
    Default implementation uses a predicate for removal.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Returns:
    
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(CharLookupContainer c)
```
    Default implementation uses a predicate for retaining.
    
    Specified by:
    
    retainAll in interface CharCollection
    
    Returns:
    
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(CharPredicate predicate)
```
    Default implementation redirects to CharCollection.removeAll(CharPredicate) and negates the predicate.
    
    Specified by:
    
    retainAll in interface CharCollection
    
    Returns:
    
    Returns the number of removed elements.
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Class CharArrayList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.CharCollection

Methods inherited from interface java.lang.Iterable

Field Detail

EMPTY_ARRAY

buffer

elementsCount

resizer

Constructor Detail

CharArrayList

CharArrayList

CharArrayList

CharArrayList

Method Detail

add

add

add

add

addAll

addAll

insert

get

set

remove

removeRange

removeFirst

removeLast

removeAll

contains

indexOf

lastIndexOf

isEmpty

ensureCapacity

ensureBufferSpace

resize

size

trimToSize

clear

release

toArray

clone

hashCode

equals

equalElements

iterator

forEach

forEach

removeAll

forEach

forEach

from

removeAll

retainAll

retainAll

toString