/**
 * <b>Bestandteil des Zentralabiturs 2009</b><br>
 * <br>
 * Objekte der Klasse Stack (Keller, Stapel) verwalten beliebige Objekte nach dem
 * Last-In-First-Out-Prinzip, d.h., dass das zuletzt abgelegte Element als erstes wieder
 * entnommen wird. Die Klasse Stack stellt Methoden in folgender Syntax zur Verfügung:
 * <ul>
 * <li>public Stack()</li>
 * <li>public boolean isEmpty()</li>
 * <li>public void push (Object pObject)</li>
 * <li>public void pop ()</li>
 * <li>public Object top ()</li>
 */
public class Stack
{

	/**
	 * Attribut oberstes Element des Stapels.
	 */
	private Element top;

	/**
	 * Der Konstruktor erzeugt einen leeren Stapel.<br>
	 * <br>
	 *
	 * <pre>
	 *  Konstruktor  Stack()
	 *  Nachher      Ein leerer Stapel ist erzeugt.
	 * </pre>
	 */
	public Stack()
	{
		this.top = null;
	}

	/**
	 * Ist der Stapel leer?<br>
	 * <br>
	 *
	 * <pre>
	 * Anfrage      isEmpty()
	 * Nachher      Die Anfrage liefert den Wert true, wenn der Stapel keine Elemente
	 *              enthält, sonst liefert sie den Wert false.
	 * </pre>
	 *
	 * @return true, wenn der Stapel keine Elemente enthält, sonst false.
	 */
	public boolean isEmpty()
	{
		return this.top == null;
	}

	/**
	 * Entfernt das oberste Stapelelement.<br>
	 * <br>
	 *
	 * <pre>
	 * Auftrag      pop()
	 * Vorher       Der Stapel ist nicht leer.
	 * Nachher      Das zuletzt eingefügte Element ist aus dem Stapel entfernt.
	 * </pre>
	 */
	public void pop()
	{
		if (!this.isEmpty())
		{
			this.top = this.top.getNext();
		}
	}

	/**
	 * Legt ein neues Element oben auf dem Stapel.<br>
	 * <br>
	 *
	 * <pre>
	 * Auftrag      push (Object pObject)
	 * Vorher       Der Stapel ist erzeugt.
	 * Nachher      pObject liegt oben auf dem Stack.
	 * </pre>
	 *
	 * @param pObject neues Stapelelement.
	 */
	public void push(Object pObject)
	{
		Element newItem = new Element(pObject, null);
		if (!this.isEmpty())
		{
			newItem.setNext(this.top);
		}
		this.top = newItem;
	}

	/**
	 * Liefert das oberste Stapelelement ohne den Stapel zu verändern.<br>
	 * <br>
	 *
	 * <pre>
	 * Anfrage      top():Object
	 * Vorher       Der Stapel ist nicht leer.
	 * Nachher      Die Anfrage liefert das oberste Stapelelement. Der Stapel ist unverändert.
	 * </pre>
	 *
	 * @return oberstes Stapelelement
	 */
	public Object top()
	{
		Object item = null;
		if (!this.isEmpty())
		{
			item = this.top.getItem();
		}
		return item;
	}

}