com.helger.commons.collection

Class StackHelper

java.lang.Object

com.helger.commons.collection.StackHelper

@Immutable
public final class StackHelper
extends Object

Method Summary

Modifier and Type	Method and Description
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	getStackCopyWithoutTop(NonBlockingStack<ELEMENTTYPE> aStack)
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	newStack()
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	newStack(Collection<? extends ELEMENTTYPE> aValues) Create a new stack from the given collection.
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	newStack(ELEMENTTYPE... aValues) Create a new stack from the given array.
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	newStack(ELEMENTTYPE aValue) Create a new stack with a single element.
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	newStack(int nInitialCapacity)
static <SRCTYPE,DSTTYPE> NonBlockingStack<DSTTYPE>	newStackMapped(Collection<? extends SRCTYPE> aCollection, Function<? super SRCTYPE,DSTTYPE> aMapper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newStack

@Nonnull
 @ReturnsMutableCopy
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> newStack(@Nonnegative
                                                                                                   int nInitialCapacity)

newStack

@Nonnull
 @ReturnsMutableCopy
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> newStack()

newStackMapped

@Nonnull
 @ReturnsMutableCopy
public static <SRCTYPE,DSTTYPE> NonBlockingStack<DSTTYPE> newStackMapped(@Nullable
                                                                                                         Collection<? extends SRCTYPE> aCollection,
                                                                                                         @Nonnull
                                                                                                         Function<? super SRCTYPE,DSTTYPE> aMapper)

newStack

@Nonnull
 @ReturnsMutableCopy
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> newStack(@Nullable
                                                                                                   ELEMENTTYPE aValue)

Create a new stack with a single element.

Type Parameters:

ELEMENTTYPE - The type of elements contained in the stack.

Parameters:

aValue - The value to push. Maybe null.

Returns:

A non-null stack.

newStack

@Nonnull
 @ReturnsMutableCopy
 @SafeVarargs
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> newStack(@Nullable
                                                                                                                  ELEMENTTYPE... aValues)

Create a new stack from the given array.

Type Parameters:

ELEMENTTYPE - The type of elements contained in the stack.

Parameters:

aValues - The values that are to be pushed on the stack. The last element will be the top element on the stack. May not be null .

Returns:

A non-null stack object.

newStack

@Nonnull
 @ReturnsMutableCopy
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> newStack(@Nullable
                                                                                                   Collection<? extends ELEMENTTYPE> aValues)

Create a new stack from the given collection.

Type Parameters:

ELEMENTTYPE - The type of elements contained in the stack.

Parameters:

aValues - The values that are to be pushed on the stack. The last element will be the top element on the stack. May not be null .

Returns:

A non-null stack object.

getStackCopyWithoutTop

@Nullable
 @ReturnsMutableCopy
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> getStackCopyWithoutTop(@Nullable
                                                                                                                  NonBlockingStack<ELEMENTTYPE> aStack)