CharStack (HPPC v0.5.2 API Documentation (JavaDoc))

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

All Implemented Interfaces:

CharCollection, CharContainer, CharIndexedContainer, java.lang.Cloneable, java.lang.Iterable<CharCursor>, java.util.RandomAccess
```
@Generated(date="2013-07-09T09:54:21+0200",
           value="HPPC generated from: CharStack.java")
public class CharStack
extends CharArrayList
```
An extension to CharArrayList adding stack-related utility methods. The top of the stack is at the CharArrayList.size() - 1 element.
See ObjectArrayList class for API similarities and differences against Java Collections.

Field Summary
- Fields inherited from class com.carrotsearch.hppc.CharArrayList
  buffer, DEFAULT_CAPACITY, elementsCount, resizer

Constructor Summary

Constructors
Constructor and Description
`CharStack()` Create with default sizing strategy and initial capacity.
`CharStack(CharContainer container)` Create a stack by pushing all elements of another container to it.
`CharStack(int initialCapacity)` Create with default sizing strategy and the given initial capacity.
`CharStack(int initialCapacity, ArraySizingStrategy resizer)` Create with a custom buffer resizing strategy.

Method Summary

Methods
Modifier and Type	Method and Description
`CharStack`	`clone()` Clone this object.
`void`	`discard()` Discard the top element from the stack.
`void`	`discard(int count)` Discard an arbitrary number of elements from the top of the stack.
`static CharStack`	`from(char... elements)` Create a stack by pushing a variable number of arguments to it.
`static CharStack`	`from(CharContainer container)` Create a stack by pushing all elements of another container to it.
`static CharStack`	`newInstance()` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`static CharStack`	`newInstanceWithCapacity(int initialCapacity)` Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
`char`	`peek()` Peek at the top element on the stack.
`char`	`pop()` Remove the top element from the stack and return it.
`void`	`push(char... elements)` Vararg-signature method for pushing elements at the top of the stack.
`void`	`push(char e1)` Adds one char to the stack.
`void`	`push(char[] elements, int start, int len)` Add a range of array elements to the stack.
`void`	`push(char e1, char e2)` Adds two chars to the stack.
`void`	`push(char e1, char e2, char e3)` Adds three chars to the stack.
`void`	`push(char e1, char e2, char e3, char e4)` Adds four chars to the stack.
`int`	`pushAll(CharContainer container)` Pushes all elements from another container to the top of the stack.
`int`	`pushAll(java.lang.Iterable<? extends CharCursor> iterable)` Pushes all elements from another iterable to the top of the stack.
`int`	`removeAll(CharLookupContainer c)` Default implementation uses a predicate for removal.
`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.
`java.lang.String`	`toString()` Convert the contents of this container to a human-friendly string.

Methods inherited from class com.carrotsearch.hppc.CharArrayList
add, add, add, add, addAll, addAll, clear, contains, ensureBufferSpace, ensureCapacity, equals, forEach, forEach, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAllOccurrences, removeFirstOccurrence, removeLastOccurrence, removeRange, resize, set, size, toArray, trimToSize

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

- Constructor Detail
  - CharStack
```
public CharStack()
```
    Create with default sizing strategy and initial capacity.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - CharStack
```
public CharStack(int initialCapacity)
```
    Create with default sizing strategy and the given initial capacity.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - CharStack
```
public CharStack(int initialCapacity,
         ArraySizingStrategy resizer)
```
    Create with a custom buffer resizing strategy.
  - CharStack
```
public CharStack(CharContainer container)
```
    Create a stack by pushing all elements of another container to it.
- Method Detail
  - push
```
public void push(char e1)
```
    Adds one char to the stack.
  - push
```
public void push(char e1,
        char e2)
```
    Adds two chars to the stack.
  - push
```
public void push(char e1,
        char e2,
        char e3)
```
    Adds three chars to the stack.
  - push
```
public void push(char e1,
        char e2,
        char e3,
        char e4)
```
    Adds four chars to the stack.
  - push
```
public void push(char[] elements,
        int start,
        int len)
```
    Add a range of array elements to the stack.
  - push
```
public void push(char... elements)
```
    Vararg-signature method for pushing elements at the top of the stack.
    This method is handy, but costly if used in tight loops (anonymous array passing)
  - pushAll
```
public int pushAll(CharContainer container)
```
    Pushes all elements from another container to the top of the stack.
  - pushAll
```
public int pushAll(java.lang.Iterable<? extends CharCursor> iterable)
```
    Pushes all elements from another iterable to the top of the stack.
  - discard
```
public void discard(int count)
```
    Discard an arbitrary number of elements from the top of the stack.
  - discard
```
public void discard()
```
    Discard the top element from the stack.
  - pop
```
public char pop()
```
    Remove the top element from the stack and return it.
  - peek
```
public char peek()
```
    Peek at the top element on the stack.
  - newInstance
```
public static CharStack newInstance()
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - newInstanceWithCapacity
```
public static CharStack newInstanceWithCapacity(int initialCapacity)
```
    Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
  - from
```
public static CharStack from(char... elements)
```
    Create a stack by pushing a variable number of arguments to it.
  - from
```
public static CharStack from(CharContainer container)
```
    Create a stack by pushing all elements of another container to it.
  - clone
```
public CharStack clone()
```
    Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
    
    Overrides:
    
    clone in class CharArrayList
  - 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
  - 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 CharStack

Field Summary

Fields inherited from class com.carrotsearch.hppc.CharArrayList

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppc.CharArrayList

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.CharCollection

Constructor Detail

CharStack

CharStack

CharStack

CharStack

Method Detail

push

push

push

push

push

push

pushAll

pushAll

discard

discard

pop

peek

newInstance

newInstanceWithCapacity

from

from

clone

removeAll

retainAll

retainAll

toString