org.dmfs.jems.stack.decorators

Class Topped<Element>

java.lang.Object

org.dmfs.jems.stack.decorators.Topped<Element>

Type Parameters:

Element - The type of the elements on the Stack.

All Implemented Interfaces:

Stack<Element>

public final class Topped<Element>
extends java.lang.Object
implements Stack<Element>

A Stack based on another Stack and a new top element.

Nested Class Summary

Nested classes/interfaces inherited from interface org.dmfs.jems.stack.Stack

Stack.StackTop<Element>

Constructor Summary

Constructors

Constructor and Description
Topped(Element element, Stack<Element> bottom) Creates a new Stack with the given element on top and the given Stack underneath.

Method Summary

Modifier and Type	Method and Description
Optional<Stack.StackTop<Element>>	top() Retrieves the top of this Stack.

Methods inherited from class java.lang.Object

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

Constructor Detail

Topped

public Topped(Element element,
              Stack<Element> bottom)

Creates a new Stack with the given element on top and the given Stack underneath.

Parameters:

element - The top element of the Stack.

bottom - The Stack underneath the top element.

Method Detail

top

public Optional<Stack.StackTop<Element>> top()

Description copied from interface: Stack

Retrieves the top of this Stack. If the stack is empty the Stack.StackTop will be absent.

Specified by:

top in interface Stack<Element>

Returns:

An Optional Stack.StackTop.