CharList

java.lang.Object
- de.grogra.xl.util.CharList

All Implemented Interfaces:

CharConsumer, VoidToCharGenerator, java.io.Serializable, java.lang.Cloneable
```
public class CharList
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, CharConsumer, VoidToCharGenerator
```
A CharList represents a list of char values. It provides list- and stack-oriented methods for insertion, addition, and removal, of values. The methods are not thread-safe.

Author:

Ole Kniemeyer

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

char[] elements
The array holding the elements.

int size
The size of this list.

Fields
Modifier and Type	Field and Description
`char[]`	`elements` The array holding the elements.
`int`	`size` The size of this list.

Constructor Summary

Constructors
Constructor and Description
`CharList()` Constructs a new `CharList`.
`CharList(char[] elements)` Constructs a new `CharList` whose elements are a copy of `elements`.
`CharList(int capacity)` Constructs a new `CharList` with a given initial capacity.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(char o)` Adds `o` as last element to this list.
`void`	`add(int index, char o)` Inserts `o` at position `index` to this list.
`CharList`	`addAll(char[] v, int begin, int length)` Appends `length` components of `v` to this list, starting at index `begin`.
`CharList`	`addAll(CharList v)` Appends all elements of `v` to this list.
`void`	`addIfNotContained(char o)` Adds `o` as last element to this list if is not yet contained as reported by `contains(char)`.
`static void`	`arraycopy(char[] src, int srcIndex, char[] dest, int destIndex, int length)`
`int`	`binarySearch(char value)` Searches this list for the specified value using the binary search algorithm.
`static int`	`binarySearch(char[] array, char value)`
`static int`	`binarySearch(char[] array, char value, int fromIndex, int toIndex)`
`void`	`clear()` Removes all of the elements from this list.
`static void`	`clear(char[] array, int index, int length)`
`java.lang.Object`	`clone()`
`void`	`consume(char value)` Receives a value of type `char`.
`boolean`	`contains(char o)` Returns `true` iff this list contains the given element `o`.
`void`	`ensureCapacity(int capacity)` Ensures a capacity of the internal array of at least `capacity`.
`boolean`	`equals(java.lang.Object o)`
`void`	`evaluateChar(CharConsumer cons)` This generator method yields all values to `cons`.
`char`	`get(int index)` Returns the list element at `index`.
`int`	`hashCode()`
`int`	`indexOf(char o)` Returns the index of `o` in this list.
`boolean`	`isEmpty()` Returns if this list is empty, i.e., if its size is zero.
`int`	`lastIndexOf(char o)` Returns the last index of `o` in this list.
`char`	`peek(int index)` Returns the list element at `index` as seen from the top, i.e., at absolute position `size - index`.
`char`	`pop()` Removes and returns the object at the top of this list.
`CharList`	`push(char o)` Pushes `o` on top of this list, i.e., as last element.
`CharList`	`push(char o1, char o2)` Pushes `o1` and `o2` on top of this list, i.e., as last elements.
`CharList`	`push(char o1, char o2, char o3)` Pushes `o1 ... o3` on top of this list, i.e., as last elements.
`boolean`	`remove(char o)` Removes the element `o`.
`char`	`removeAt(int index)` Removes the element at position `index`.
`char`	`set(int index, char o)` Sets the element at position `index` to `o`.
`void`	`setSize(int size)` Sets the size of this list to the given value.
`int`	`size()` Returns the size of this list.
`char[]`	`toArray()` Returns an array containing the elements of this list.
`char[]`	`toArray(char[] array)` Returns an array containing the elements of this list.
`java.lang.String`	`toString()`
`void`	`trimToSize()` Trims the capacity of this list to be its current size.
`void`	`values(CharConsumer cons)` This method is an alias for `evaluateChar(de.grogra.xl.lang.CharConsumer)`.
`void`	`writeTo(java.nio.CharBuffer out)`

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

- Field Detail
  - elements
```
public transient char[] elements
```
    The array holding the elements. Only the components from 0 to size - 1 are valid. Direct operation on this array has to be designed carefully to avoid inconsistencies.
  - size
```
public int size
```
    The size of this list. Direct operation on this field has to be designed carefully to avoid inconsistencies.
- Constructor Detail
  - CharList
```
public CharList()
```
    Constructs a new CharList.
  - CharList
```
public CharList(char[] elements)
```
    Constructs a new CharList whose elements are a copy of elements.
    
    Parameters:
    elements - the initial elements of the list
  - CharList
```
public CharList(int capacity)
```
    Constructs a new CharList with a given initial capacity.
    
    Parameters:
    capacity - the initial capacity
- Method Detail
  - add
```
public boolean add(char o)
```
    Adds o as last element to this list.
    
    Parameters:
    o - the value to add
    
    Returns:
    true
  - add
```
public void add(int index,
       char o)
```
    Inserts o at position index to this list. If index is not less than size, the list is enlarged and filled with 0-values before.
    
    Parameters:
    index - the insert position
    o - the value to insert
  - addAll
```
public CharList addAll(char[] v,
              int begin,
              int length)
```
    Appends length components of v to this list, starting at index begin.
    
    Parameters:
    v - the array of elements to add
    begin - the array index to begin with
    length - the number of elements to add
    
    Returns:
    this list
  - addAll
```
public CharList addAll(CharList v)
```
    Appends all elements of v to this list.
    
    Parameters:
    v - the list of elements to add
    
    Returns:
    this list
  - addIfNotContained
```
public void addIfNotContained(char o)
```
    Adds o as last element to this list if is not yet contained as reported by contains(char).
    
    Parameters:
    o - the value to add
  - arraycopy
```
public static void arraycopy(char[] src,
             int srcIndex,
             char[] dest,
             int destIndex,
             int length)
```
  - binarySearch
```
public int binarySearch(char value)
```
    Searches this list for the specified value using the binary search algorithm. This list has to be sorted in ascending order.
    
    Parameters:
    value - the value to be searched for
    
    Returns:
    index of the searched value, if it is contained in this list; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the value would be inserted into the list: the index of the first element greater than the value, or size(), if all elements in the list are less than the specified value.
  - binarySearch
```
public static int binarySearch(char[] array,
               char value)
```
  - binarySearch
```
public static int binarySearch(char[] array,
               char value,
               int fromIndex,
               int toIndex)
```
  - clear
```
public void clear()
```
    Removes all of the elements from this list. The list will be empty after this call returns.
  - clear
```
public static void clear(char[] array,
         int index,
         int length)
```
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - consume
```
public void consume(char value)
```
    Description copied from interface: CharConsumer
    
    Receives a value of type char.
    
    Specified by:
    
    consume in interface CharConsumer
  - contains
```
public boolean contains(char o)
```
    Returns true iff this list contains the given element o.
    
    Parameters:
    o - a value
    
    Returns:
    true iff o is contained
  - ensureCapacity
```
public void ensureCapacity(int capacity)
```
    Ensures a capacity of the internal array of at least capacity.
    
    Parameters:
    capacity - the desired minimum capacity
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - evaluateChar
```
public void evaluateChar(CharConsumer cons)
```
    This generator method yields all values to cons.
    
    Specified by:
    
    evaluateChar in interface VoidToCharGenerator
    
    Parameters:
    cons - the consumer which receives the values
  - get
```
public char get(int index)
```
    Returns the list element at index. If index is not less than size, 0 is returned.
    
    Parameters:
    index - the position
    
    Returns:
    the value at index
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - indexOf
```
public int indexOf(char o)
```
    Returns the index of o in this list.
    
    Parameters:
    o - a value
    
    Returns:
    the index of o, or -1 of o is not contained
  - isEmpty
```
public final boolean isEmpty()
```
    Returns if this list is empty, i.e., if its size is zero.
    
    Returns:
    true iff this list is empty
  - lastIndexOf
```
public int lastIndexOf(char o)
```
    Returns the last index of o in this list.
    
    Parameters:
    o - a value
    
    Returns:
    the index of o, or -1 of o is not contained
  - peek
```
public char peek(int index)
```
    Returns the list element at index as seen from the top, i.e., at absolute position size - index. Thus, the topmost element has index 1.
    
    Parameters:
    index - the position as seen from the top
    
    Returns:
    the value at that position
  - pop
```
public char pop()
```
    Removes and returns the object at the top of this list.
    
    Returns:
    the removed object from the top of this list
  - push
```
public final CharList push(char o)
```
    Pushes o on top of this list, i.e., as last element.
    
    Parameters:
    o - the value to push
    
    Returns:
    this list
  - push
```
public final CharList push(char o1,
            char o2)
```
    Pushes o1 and o2 on top of this list, i.e., as last elements. The effect is the same as the invocation list.push(o1).push(o2).
    
    Parameters:
    o1 - the first value to push
    o2 - the second value to push
    
    Returns:
    this list
  - push
```
public final CharList push(char o1,
            char o2,
            char o3)
```
    Pushes o1 ... o3 on top of this list, i.e., as last elements. The effect is the same as the invocation list.push(o1).push(o2).push(o3).
    
    Parameters:
    o1 - the first value to push
    o2 - the second value to push
    o3 - the third value to push
    
    Returns:
    this list
  - remove
```
public boolean remove(char o)
```
    Removes the element o. The last occurence of o in this list is removed.
    
    Parameters:
    o - the element to be removed
    
    Returns:
    true iff o was found and removed from the list
  - removeAt
```
public char removeAt(int index)
```
    Removes the element at position index.
    
    Parameters:
    index - the position of the element to be removed
    
    Returns:
    the value of the removed element
  - set
```
public char set(int index,
       char o)
```
    Sets the element at position index to o. If index is not less than size, the list is enlarged and filled with 0-values before.
    
    Parameters:
    index - the position
    o - the new value
    
    Returns:
    the old value at index
  - setSize
```
public void setSize(int size)
```
    Sets the size of this list to the given value. If the new size is greater than the old size, the new elements are initialized with 0-values.
    
    Parameters:
    size - the new size
  - size
```
public final int size()
```
    Returns the size of this list.
    
    Returns:
    the size
  - toArray
```
public char[] toArray()
```
    Returns an array containing the elements of this list.
    
    Returns:
    an array copy of this list
  - toArray
```
public char[] toArray(char[] array)
```
    Returns an array containing the elements of this list. The type of the returned array is that of the specified array. If this list fits in the specified array, it is returned therein. Otherwise, a new array is allocated whose length is the size of this list's size, the values of this list are copied into the new array, and this array is returned.
    If there is room for an additional element in the array, a 0-value is written behind the last copied element.
    
    Parameters:
    array - an array to use
    
    Returns:
    an array copy of this list
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - trimToSize
```
public void trimToSize()
```
    Trims the capacity of this list to be its current size.
  - values
```
public void values(CharConsumer cons)
```
    This method is an alias for evaluateChar(de.grogra.xl.lang.CharConsumer).
  - writeTo
```
public void writeTo(java.nio.CharBuffer out)
```

Class CharList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elements

size

Constructor Detail

CharList

CharList

CharList

Method Detail

add

add

addAll

addAll

addIfNotContained

arraycopy

binarySearch

binarySearch

binarySearch

clear

clear

clone

consume

contains

ensureCapacity

equals

evaluateChar

get

hashCode

indexOf

isEmpty

lastIndexOf

peek

pop

push

push

push

remove

removeAt

set

setSize

size

toArray

toArray

toString

trimToSize

values

writeTo