KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > helpers > NothingIterator


1 /**
2  * $Id: NothingIterator.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 1997-2004 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 as published by the
8  * Free Software Foundation; either version 2.1 of the License, or (at your option) any
9  * 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 (GNU Lesser General Public License) 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 LGPL can be found online at
18  * http://www.fsf.org/copyleft/lesser.html
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.helpers;
30
31 import java.util.Enumeration JavaDoc;
32 import java.util.NoSuchElementException JavaDoc;
33
34 /**
35  * Iterator that iterates nothing&#150; <span class="src">hasNext()</span> is always
36  * <i>false</i>. A NothingIterator instance can be used as an MT-safe singleton.
37  *
38  * @since JWare/core 0.1
39  * @author ssmc, &copy;1997-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
40  * @version 0.5
41  * @.safety single
42  * @.group impl,helper
43  **/
44
45 public class NothingIterator extends NoRemoveIteratorSkeleton
46     implements Enumeration JavaDoc
47 {
48     /**
49      * VM/ClassLoader-shareable singleton.
50      **/
51     public static final NothingIterator INSTANCE= new NothingIterator();
52
53
54     /**
55      * Creates new nothing iterator object to iterate nothing.
56      **/
57     public NothingIterator()
58     {
59     }
60
61
62
63     /**
64      * Nothing to return; always throws a
65      * <span class="src">NoSuchElementException</span> exception.
66      **/
67     public Object JavaDoc next()
68     {
69         throw new NoSuchElementException JavaDoc();
70     }
71
72
73     /**
74      * Nothing to return; always throws a
75      * <span class="src">NoSuchElementException</span> exception.
76      **/
77     public Object JavaDoc nextElement()
78     {
79         throw new NoSuchElementException JavaDoc();
80     }
81
82
83     /**
84      * Nothing to return; always returns <i>false</i>.
85      **/
86     public boolean hasMoreElements()
87     {
88         return false;
89     }
90
91
92     /**
93      * Nothing to return; always returns <i>false</i>.
94      **/
95     public boolean hasNext()
96     {
97         return false;
98     }
99 }
100
101 /* end-of-NothingIterator.java */
102
Popular Tags