KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > mlw > vlh > ValueList


1 /**
2  * Copyright (c) 2003 held jointly by the individual authors.
3  *
4  * This library is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License as published
6  * by the Free Software Foundation; either version 2.1 of the License, or
7  * (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; with out even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this library; if not, write to the Free Software Foundation,
16  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  *
18  * > http://www.gnu.org/copyleft/lesser.html
19  * > http://www.opensource.org/licenses/lgpl-license.php
20  */

21 package net.mlw.vlh;
22
23 import java.io.Serializable JavaDoc;
24 import java.util.Iterator JavaDoc;
25 import java.util.List JavaDoc;
26 import java.util.NoSuchElementException JavaDoc;
27
28 /** A <code>ValueList</code> contains a
29  * <code>List</code> of beans and a
30  * <code>ValueListInfo</code> object which
31  * defines the sorting and paging of the
32  * contained list.
33  *
34  * @author Matthew L. Wilson
35  * @version $Revision: 1.2 $ $Date: 2004/06/25 16:42:41 $
36  */

37 public interface ValueList extends Serializable JavaDoc, Iterator JavaDoc
38 {
39    /** Returns the embeded <code>List</code>
40     * @return The embeded <code>List</code>
41     */

42    List JavaDoc getList();
43
44    /** Returns the embeded <code>ValueListInfo</code>
45     * @return The embeded <code>ValueListInfo</code>
46     */

47    ValueListInfo getValueListInfo();
48
49    /** Returns if there more Objects in the Iterator
50     * @return true if there more Objects in the Iterator, other
51     * wise false
52     */

53    boolean hasNext();
54
55    /** Gets the next Object in the Iterator.
56     * @throws NoSuchElementException If element does not exist.
57     * @return The next Object in the Iterator.
58     */

59    Object JavaDoc next() throws NoSuchElementException JavaDoc;
60 }
Popular Tags