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

java.lang.Object
- com.carrotsearch.hppc.ObjectArrayList<KType>
- - com.carrotsearch.hppc.ObjectStack<KType>

All Implemented Interfaces:: ObjectCollection<KType>, ObjectContainer<KType>, ObjectIndexedContainer<KType>, java.lang.Cloneable, java.lang.Iterable<ObjectCursor<KType>>, java.util.RandomAccess

@Generated(date="2013-07-09T09:54:21+0200",
           value="HPPC generated from: ObjectStack.java")
public class ObjectStack<KType>
extends ObjectArrayList<KType>

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the ObjectArrayList.size() - 1 element. A brief comparison of the API against the Java Collections framework:

Java Collections Stack and HPPC `ObjectStack`, related methods.
java.util.Stack	`ObjectStack`
push	push
pop	pop, discard
peek	peek
removeRange, removeElementAt	removeRange, remove, discard
size	size
clear	clear, release
	+ other methods from `ObjectArrayList`

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectStack<KType>`	`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 <KType> ObjectStack<KType>`	`from(KType... elements)` Create a stack by pushing a variable number of arguments to it.
`static <KType> ObjectStack<KType>`	`from(ObjectContainer<KType> container)` Create a stack by pushing all elements of another container to it.
`static <KType> ObjectStack<KType>`	`newInstance()` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`static <KType> ObjectStack<KType>`	`newInstanceWithCapacity(int initialCapacity)` Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
`KType`	`peek()` Peek at the top element on the stack.
`KType`	`pop()` Remove the top element from the stack and return it.
`void`	`push(KType... elements)` Vararg-signature method for pushing elements at the top of the stack.
`void`	`push(KType e1)` Adds one KType to the stack.
`void`	`push(KType[] elements, int start, int len)` Add a range of array elements to the stack.
`void`	`push(KType e1, KType e2)` Adds two KTypes to the stack.
`void`	`push(KType e1, KType e2, KType e3)` Adds three KTypes to the stack.
`void`	`push(KType e1, KType e2, KType e3, KType e4)` Adds four KTypes to the stack.
`int`	`pushAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)` Pushes all elements from another iterable to the top of the stack.
`int`	`pushAll(ObjectContainer<? extends KType> container)` Pushes all elements from another container to the top of the stack.
`int`	`removeAll(ObjectLookupContainer<? extends KType> c)` Default implementation uses a predicate for removal.
`int`	`retainAll(ObjectLookupContainer<? extends KType> c)` Default implementation uses a predicate for retaining.
`int`	`retainAll(ObjectPredicate<? super KType> predicate)` Default implementation redirects to `ObjectCollection.removeAll(ObjectPredicate)` and negates the predicate.
`KType[]`	`toArray(java.lang.Class<? super KType> clazz)` Default implementation of copying to an array.
`java.lang.String`	`toString()` Convert the contents of this container to a human-friendly string.

Methods inherited from class com.carrotsearch.hppc.ObjectArrayList
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.ObjectCollection
removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer
toArray

- Constructor Detail
  - ObjectStack
```
public ObjectStack()
```
    Create with default sizing strategy and initial capacity.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - ObjectStack
```
public ObjectStack(int initialCapacity)
```
    Create with default sizing strategy and the given initial capacity.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - ObjectStack
```
public ObjectStack(int initialCapacity,
           ArraySizingStrategy resizer)
```
    Create with a custom buffer resizing strategy.
  - ObjectStack
```
public ObjectStack(ObjectContainer<KType> container)
```
    Create a stack by pushing all elements of another container to it.
- Method Detail
  - push
```
public void push(KType e1)
```
    Adds one KType to the stack.
  - push
```
public void push(KType e1,
        KType e2)
```
    Adds two KTypes to the stack.
  - push
```
public void push(KType e1,
        KType e2,
        KType e3)
```
    Adds three KTypes to the stack.
  - push
```
public void push(KType e1,
        KType e2,
        KType e3,
        KType e4)
```
    Adds four KTypes to the stack.
  - push
```
public void push(KType[] elements,
        int start,
        int len)
```
    Add a range of array elements to the stack.
  - push
```
public void push(KType... 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(ObjectContainer<? extends KType> container)
```
    Pushes all elements from another container to the top of the stack.
  - pushAll
```
public int pushAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> 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 KType pop()
```
    Remove the top element from the stack and return it.
  - peek
```
public KType peek()
```
    Peek at the top element on the stack.
  - newInstance
```
public static <KType> ObjectStack<KType> newInstance()
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - newInstanceWithCapacity
```
public static <KType> ObjectStack<KType> 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 <KType> ObjectStack<KType> from(KType... elements)
```
    Create a stack by pushing a variable number of arguments to it.
  - from
```
public static <KType> ObjectStack<KType> from(ObjectContainer<KType> container)
```
    Create a stack by pushing all elements of another container to it.
  - clone
```
public ObjectStack<KType> clone()
```
    Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
    
    Overrides:
    
    clone in class ObjectArrayList<KType>
  - removeAll
```
public int removeAll(ObjectLookupContainer<? extends KType> c)
```
    Default implementation uses a predicate for removal.
    
    Specified by:
    
    removeAll in interface ObjectCollection<KType>
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(ObjectLookupContainer<? extends KType> c)
```
    Default implementation uses a predicate for retaining.
    
    Specified by:
    
    retainAll in interface ObjectCollection<KType>
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(ObjectPredicate<? super KType> predicate)
```
    Default implementation redirects to ObjectCollection.removeAll(ObjectPredicate) and negates the predicate.
    
    Specified by:
    
    retainAll in interface ObjectCollection<KType>
  - toArray
```
public KType[] toArray(java.lang.Class<? super KType> clazz)
```
    Default implementation of copying to an array.
    
    Specified by:
    
    toArray in interface ObjectContainer<KType>
  - 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 ObjectStack<KType>

Field Summary

Fields inherited from class com.carrotsearch.hppc.ObjectArrayList

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppc.ObjectArrayList

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.ObjectCollection

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

Constructor Detail

ObjectStack

ObjectStack

ObjectStack

ObjectStack

Method Detail

push

push

push

push

push

push

pushAll

pushAll

discard

discard

pop

peek

newInstance

newInstanceWithCapacity

from

from

clone

removeAll

retainAll

retainAll

toArray

toString