Stack (RVPF-Core API Documentation)

Object
- Stack

```
public final class Stack
extends Object
```
Stack.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Stack.AccessException` Access exception.
`static class`	`Stack.CastException` Cast exception.
`static class`	`Stack.LimitsException` Limits exception.

Constructor Summary

Constructors
Constructor and Description

Stack()
Constructs a new stack.

Stack(Optional<Task> task)
Constructs a new stack.

Constructors
Constructor and Description
`Stack()` Constructs a new stack.
`Stack(Optional<Task> task)` Constructs a new stack.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears this stack.
`Task`	`getTask()` Gets the task.
`void`	`insert(int position, Serializable object)` Inserts an object at a position on this stack.
`boolean`	`isDropped()` Asks if this stack, as a mark, is dropped.
`boolean`	`isEmpty()` Asks if the stack is empty.
`boolean`	`isMarked()` Asks if this stack is marked.
`Stack`	`mark()` Marks the stack.
`Serializable`	`peek()` Peeks at the top of this stack.
`Serializable`	`peek(Class<?> expectedClass)` Peeks at the top of this stack.
`Serializable`	`peek(int position)` Peeks at a position on this stack.
`double`	`peekDoubleValue()` Peeks at the double at the top of this stack.
`long`	`peekLongValue()` Peeks at the long at the top of this stack.
`String`	`peekStringValue()` Peeks at the string for the value at the top of this stack.
`Serializable`	`pop()` Pops the object at the top of this stack.
`Serializable`	`pop(Class<?> expectedClass)` Pops the object at the top of this stack.
`boolean`	`popBooleanValue()` Pops the boolean at the top of this stack.
`double`	`popDoubleValue()` Pops the double at the top of this stack.
`int`	`popIntValue()` Pops the int at the top of this stack.
`long`	`popLongValue()` Pops the long at the top of this stack.
`String`	`popStringValue()` Pops the string at the top of this stack.
`void`	`push(boolean value)` Pushes a boolean on this stack.
`void`	`push(double value)` Pushes a double on this stack.
`void`	`push(long value)` Pushes a long on this stack.
`void`	`push(Optional<? extends Serializable> object)` Pushes an optional object on this stack (null when empty).
`void`	`push(Serializable object)` Pushes an object on this stack.
`Serializable`	`remove(int position)` Removes the object at a position on this stack.
`void`	`reverse()` Reverses the content order of this stack.
`int`	`size()` Returns the size of this stack.
`Object[]`	`toArray()` Returns this stack's content in an object array.
`Object[]`	`toArrayAll()` Returns all stacks content in an object array.
`int`	`totalSize()` Returns the total size of this stack and of the marks.
`void`	`unmark()` Unmarks the stack.
`void`	`unmarkAll()` Remove all marks.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Stack
```
public Stack()
```
    Constructs a new stack.
  - Stack
```
public Stack(@Nonnull
             Optional<Task> task)
```
    Constructs a new stack.
    
    Parameters:
    
    task - The stack's owner.
- Method Detail
  - clear
```
public void clear()
```
    Clears this stack.
  - getTask
```
@Nonnull
 @CheckReturnValue
public Task getTask()
```
    Gets the task.
    
    Returns:
    
    The task.
  - insert
```
public void insert(int position,
                   @Nullable
                   Serializable object)
            throws Stack.LimitsException
```
    Inserts an object at a position on this stack.
    
    Parameters:
    
    position - The origin zero position.
    
    object - The object to insert.
    
    Throws:
    
    Stack.LimitsException - When the position is outside the stack.
  - isDropped
```
@CheckReturnValue
public boolean isDropped()
```
    Asks if this stack, as a mark, is dropped.
    
    Returns:
    
    True if this stack is dropped.
  - isEmpty
```
@CheckReturnValue
public boolean isEmpty()
```
    Asks if the stack is empty.
    
    Returns:
    
    True if the stack is empty.
  - isMarked
```
@CheckReturnValue
public boolean isMarked()
```
    Asks if this stack is marked.
    
    Returns:
    
    True if this stack is marked.
  - mark
```
@Nonnull
 @CheckReturnValue
public Stack mark()
```
    Marks the stack.
    
    Returns:
    
    The mark.
  - peek
```
@Nullable
 @CheckReturnValue
public Serializable peek()
                                                 throws Stack.LimitsException
```
    Peeks at the top of this stack.
    
    Returns:
    
    The object at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
  - peek
```
@Nonnull
 @CheckReturnValue
public Serializable peek(@Nonnull
                                                       Class<?> expectedClass)
                                                throws Stack.LimitsException,
                                                       Stack.CastException
```
    Peeks at the top of this stack.
    
    Parameters:
    
    expectedClass - The expected class.
    
    Returns:
    
    The object at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value has not the expected class.
  - peek
```
@Nullable
 @CheckReturnValue
public Serializable peek(int position)
                                                 throws Stack.LimitsException
```
    Peeks at a position on this stack.
    
    Parameters:
    
    position - The origin zero position.
    
    Returns:
    
    The object at the position.
    
    Throws:
    
    Stack.LimitsException - When the position is outside the stack.
  - peekDoubleValue
```
@CheckReturnValue
public double peekDoubleValue()
                                          throws Stack.AccessException
```
    Peeks at the double at the top of this stack.
    
    Returns:
    
    The double at the top.
    
    Throws:
    
    Stack.AccessException - When appropriate.
  - peekLongValue
```
@CheckReturnValue
public long peekLongValue()
                                      throws Stack.LimitsException,
                                             Stack.CastException
```
    Peeks at the long at the top of this stack.
    
    Returns:
    
    The long at the top.
    
    Throws:
    
    Stack.LimitsException - When the position is outside the stack.
    
    Stack.CastException - When the value is not a number.
  - peekStringValue
```
@Nonnull
 @CheckReturnValue
public String peekStringValue()
                                                     throws Stack.LimitsException
```
    Peeks at the string for the value at the top of this stack.
    
    Returns:
    
    The string for the value at the top of this stack.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
  - pop
```
@Nullable
public Serializable pop()
                            throws Stack.LimitsException
```
    Pops the object at the top of this stack.
    
    Returns:
    
    The object at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
  - pop
```
@Nullable
 @CheckReturnValue
public Serializable pop(@Nonnull
                                                       Class<?> expectedClass)
                                                throws Stack.LimitsException,
                                                       Stack.CastException
```
    Pops the object at the top of this stack.
    
    Parameters:
    
    expectedClass - The expected class.
    
    Returns:
    
    The object at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value has not the expected class.
  - popBooleanValue
```
@CheckReturnValue
public boolean popBooleanValue()
                                           throws Stack.LimitsException,
                                                  Stack.CastException
```
    Pops the boolean at the top of this stack.
    
    Returns:
    
    The boolean at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value is not a boolean.
  - popDoubleValue
```
@CheckReturnValue
public double popDoubleValue()
                                         throws Stack.LimitsException,
                                                Stack.CastException
```
    Pops the double at the top of this stack.
    
    Returns:
    
    The double at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value is not a number.
  - popIntValue
```
@CheckReturnValue
public int popIntValue()
                                   throws Stack.LimitsException,
                                          Stack.CastException
```
    Pops the int at the top of this stack.
    
    Returns:
    
    The int at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value is not an number.
  - popLongValue
```
@CheckReturnValue
public long popLongValue()
                                     throws Stack.LimitsException,
                                            Stack.CastException
```
    Pops the long at the top of this stack.
    
    Returns:
    
    The long at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
    
    Stack.CastException - When the value is not a number.
  - popStringValue
```
@Nonnull
 @CheckReturnValue
public String popStringValue()
                                                    throws Stack.LimitsException
```
    Pops the string at the top of this stack.
    
    Returns:
    
    The string at the top.
    
    Throws:
    
    Stack.LimitsException - When the stack is empty.
  - push
```
public void push(boolean value)
```
    Pushes a boolean on this stack.
    
    Parameters:
    
    value - The boolean value.
  - push
```
public void push(double value)
```
    Pushes a double on this stack.
    
    Parameters:
    
    value - The double value.
  - push
```
public void push(long value)
```
    Pushes a long on this stack.
    
    Parameters:
    
    value - The long value.
  - push
```
public void push(@Nonnull
                 Optional<? extends Serializable> object)
```
    Pushes an optional object on this stack (null when empty).
    
    Parameters:
    
    object - The optional object.
  - push
```
public void push(@Nullable
                 Serializable object)
```
    Pushes an object on this stack.
    
    Parameters:
    
    object - The object.
  - remove
```
@Nullable
 @CheckReturnValue
public Serializable remove(int position)
                                                   throws Stack.LimitsException
```
    Removes the object at a position on this stack.
    
    Parameters:
    
    position - The origin zero position.
    
    Returns:
    
    The removed object.
    
    Throws:
    
    Stack.LimitsException - When the position is outside the stack.
  - reverse
```
public void reverse()
```
    Reverses the content order of this stack.
  - size
```
@CheckReturnValue
public int size()
```
    Returns the size of this stack.
    
    Returns:
    
    The size.
  - toArray
```
@Nonnull
 @CheckReturnValue
public Object[] toArray()
```
    Returns this stack's content in an object array.
    
    Returns:
    
    The content in an object array.
  - toArrayAll
```
@Nonnull
 @CheckReturnValue
public Object[] toArrayAll()
```
    Returns all stacks content in an object array.
    
    Returns:
    
    The content in an object array.
  - totalSize
```
@CheckReturnValue
public int totalSize()
```
    Returns the total size of this stack and of the marks.
    
    Returns:
    
    The total size.
  - unmark
```
public void unmark()
```
    Unmarks the stack.
  - unmarkAll
```
public void unmarkAll()
```
    Remove all marks.

Class Stack

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Stack

Stack

Method Detail

clear

getTask

insert

isDropped

isEmpty

isMarked

mark

peek

peek

peek

peekDoubleValue

peekLongValue

peekStringValue

pop

pop

popBooleanValue

popDoubleValue

popIntValue

popLongValue

popStringValue

push

push

push

push

push

remove

reverse

size

toArray

toArrayAll

totalSize

unmark

unmarkAll