KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > starters > ListFriendly


1 /**
2  * $Id: ListFriendly.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2004-2005 iDare Media, Inc. All rights reserved.
4  *
5  * Originally written by iDare Media, Inc. for release into the public domain. This
6  * library, source form and binary form, is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License (LGPL) as published
8  * by the Free Software Foundation; either version 2.1 of the License, or (at your option)
9  * any later version.<p>
10  *
11  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  * See the GNU LGPL for more details.<p>
14  *
15  * You should have received a copy of the GNU Lesser General Public License along with this
16  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17  * 330, Boston, MA 02111-1307 USA. The GNU LGPL can be found online at
18  * http://www.fsf.org/copyleft/lesser.html<p>
19  *
20  * This product has been influenced by several projects within the open-source community.
21  * The JWare developers wish to acknowledge the open-source community's support. For more
22  * information regarding the open-source products used within JWare, please visit the
23  * JWare website.
24  *----------------------------------------------------------------------------------------*
25  * WEBSITE- http://www.jware.info EMAIL- inquiries@jware.info
26  *----------------------------------------------------------------------------------------*
27  **/
28
29 package com.idaremedia.antx.starters;
30
31 import java.util.Iterator JavaDoc;
32
33 import org.apache.tools.ant.Project;
34
35 import com.idaremedia.antx.apis.FlexStringFriendly;
36
37 /**
38  * A component that can expose its state as an iterable list of strings. This is a
39  * readonly interfact; you cannot modify the underlying data object using it.
40  *
41  * @since JWare/AntX 0.5
42  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
43  * @version 0.5
44  * @.safety n/a
45  * @.group impl,helper
46  **/
47
48 public interface ListFriendly extends FlexStringFriendly
49 {
50     /**
51      * Returns an iterator for a <em>snapshot</em> of this item's
52      * current contents. Modifications via the returned iterator are
53      * <em>not</em> reflected in this item.
54      * @param project [optional] source project for property resolution
55      **/
56     Iterator JavaDoc readonlyStringIterator(Project project);
57
58
59
60     /**
61      * Returns <i>true</i> if this iterable item is empty.
62      **/
63      boolean isEmpty();
64
65
66
67     /**
68      * Returns the number of elements in this iterable item. Returned
69      * number should be zero or greater.
70      **/
71      int size();
72 }
73
74
75 /* end-of-ListFriendly.java */
Popular Tags