View Javadoc

1   /* Copyright (C) 2003 Internet Archive.
2    *
3    * This file is part of the Heritrix web crawler (crawler.archive.org).
4    *
5    * Heritrix is free software; you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser Public License as published by
7    * the Free Software Foundation; either version 2.1 of the License, or
8    * any later version.
9    *
10   * Heritrix is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser Public License
16   * along with Heritrix; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   *
19   * Stack.java
20   * Created on May 21, 2004
21   *
22   * $Header$
23   */
24  
25  package org.archive.queue;
26  
27  
28  /***
29   * Simple Stack: supports add and remove at top.
30   *
31   * @author gojomo
32   * @deprecated As of 1.10.0. Unused.
33   */
34  public interface Stack {
35      /***
36       * Add object to top of Stack
37       *
38       * @param object
39       */
40      public void push(Object object);
41  
42      /***
43       * Remove and return item from top of Stack
44       * @return Item removed from top of Stack
45       */
46      public Object pop();
47  
48      /***
49       * @return Return item from top of Stack without removing it.
50       */
51      public Object peek();
52  
53      /***
54       * Number of items in the Stack.
55       */
56      public long height();
57  
58      /***
59       * Release any OS resources, if necessary.
60       */
61      public void release();
62  
63      /***
64       * @return True if empty.
65       */
66      public boolean isEmpty();
67  }