< prev index next >

src/java.base/share/classes/java/util/Stack.java

Print this page

        

*** 24,39 **** */ package java.util; /** ! * The <code>Stack</code> class represents a last-in-first-out ! * (LIFO) stack of objects. It extends class <tt>Vector</tt> with five * operations that allow a vector to be treated as a stack. The usual ! * <tt>push</tt> and <tt>pop</tt> operations are provided, as well as a ! * method to <tt>peek</tt> at the top item on the stack, a method to test ! * for whether the stack is <tt>empty</tt>, and a method to <tt>search</tt> * the stack for an item and discover how far it is from the top. * <p> * When a stack is first created, it contains no items. * * <p>A more complete and consistent set of LIFO stack operations is --- 24,39 ---- */ package java.util; /** ! * The {@code Stack} class represents a last-in-first-out ! * (LIFO) stack of objects. It extends class {@code Vector} with five * operations that allow a vector to be treated as a stack. The usual ! * {@code push} and {@code pop} operations are provided, as well as a ! * method to {@code peek} at the top item on the stack, a method to test ! * for whether the stack is {@code empty}, and a method to {@code search} * the stack for an item and discover how far it is from the top. * <p> * When a stack is first created, it contains no items. * * <p>A more complete and consistent set of LIFO stack operations is
*** 58,68 **** * the same effect as: * <blockquote><pre> * addElement(item)</pre></blockquote> * * @param item the item to be pushed onto this stack. ! * @return the <code>item</code> argument. * @see java.util.Vector#addElement */ public E push(E item) { addElement(item); --- 58,68 ---- * the same effect as: * <blockquote><pre> * addElement(item)</pre></blockquote> * * @param item the item to be pushed onto this stack. ! * @return the {@code item} argument. * @see java.util.Vector#addElement */ public E push(E item) { addElement(item);
*** 72,82 **** /** * Removes the object at the top of this stack and returns that * object as the value of this function. * * @return The object at the top of this stack (the last item ! * of the <tt>Vector</tt> object). * @throws EmptyStackException if this stack is empty. */ public synchronized E pop() { E obj; int len = size(); --- 72,82 ---- /** * Removes the object at the top of this stack and returns that * object as the value of this function. * * @return The object at the top of this stack (the last item ! * of the {@code Vector} object). * @throws EmptyStackException if this stack is empty. */ public synchronized E pop() { E obj; int len = size();
*** 90,100 **** /** * Looks at the object at the top of this stack without removing it * from the stack. * * @return the object at the top of this stack (the last item ! * of the <tt>Vector</tt> object). * @throws EmptyStackException if this stack is empty. */ public synchronized E peek() { int len = size(); --- 90,100 ---- /** * Looks at the object at the top of this stack without removing it * from the stack. * * @return the object at the top of this stack (the last item ! * of the {@code Vector} object). * @throws EmptyStackException if this stack is empty. */ public synchronized E peek() { int len = size();
*** 104,132 **** } /** * Tests if this stack is empty. * ! * @return <code>true</code> if and only if this stack contains ! * no items; <code>false</code> otherwise. */ public boolean empty() { return size() == 0; } /** * Returns the 1-based position where an object is on this stack. ! * If the object <tt>o</tt> occurs as an item in this stack, this * method returns the distance from the top of the stack of the * occurrence nearest the top of the stack; the topmost item on the ! * stack is considered to be at distance <tt>1</tt>. The <tt>equals</tt> ! * method is used to compare <tt>o</tt> to the * items in this stack. * * @param o the desired object. * @return the 1-based position from the top of the stack where ! * the object is located; the return value <code>-1</code> * indicates that the object is not on the stack. */ public synchronized int search(Object o) { int i = lastIndexOf(o); --- 104,132 ---- } /** * Tests if this stack is empty. * ! * @return {@code true} if and only if this stack contains ! * no items; {@code false} otherwise. */ public boolean empty() { return size() == 0; } /** * Returns the 1-based position where an object is on this stack. ! * If the object {@code o} occurs as an item in this stack, this * method returns the distance from the top of the stack of the * occurrence nearest the top of the stack; the topmost item on the ! * stack is considered to be at distance {@code 1}. The {@code equals} ! * method is used to compare {@code o} to the * items in this stack. * * @param o the desired object. * @return the 1-based position from the top of the stack where ! * the object is located; the return value {@code -1} * indicates that the object is not on the stack. */ public synchronized int search(Object o) { int i = lastIndexOf(o);
< prev index next >