View Javadoc

1   /*
2    * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3    *
4    * This software is open source.
5    * See the bottom of this file for the licence.
6    */
7   
8   package org.dom4j.tree;
9   
10  import java.util.Iterator;
11  
12  /***
13   * <p>
14   * <code>SingleIterator</code> is an {@link Iterator}over a single object
15   * instance.
16   * </p>
17   * 
18   * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
19   * @version $Revision: 1.9 $
20   */
21  public class SingleIterator implements Iterator {
22      private boolean first = true;
23  
24      private Object object;
25  
26      public SingleIterator(Object object) {
27          this.object = object;
28      }
29  
30      public boolean hasNext() {
31          return first;
32      }
33  
34      public Object next() {
35          Object answer = object;
36          object = null;
37          first = false;
38  
39          return answer;
40      }
41  
42      public void remove() {
43          throw new UnsupportedOperationException("remove() is not supported by "
44                  + "this iterator");
45      }
46  }
47  
48  /*
49   * Redistribution and use of this software and associated documentation
50   * ("Software"), with or without modification, are permitted provided that the
51   * following conditions are met:
52   * 
53   * 1. Redistributions of source code must retain copyright statements and
54   * notices. Redistributions must also contain a copy of this document.
55   * 
56   * 2. Redistributions in binary form must reproduce the above copyright notice,
57   * this list of conditions and the following disclaimer in the documentation
58   * and/or other materials provided with the distribution.
59   * 
60   * 3. The name "DOM4J" must not be used to endorse or promote products derived
61   * from this Software without prior written permission of MetaStuff, Ltd. For
62   * written permission, please contact dom4j-info@metastuff.com.
63   * 
64   * 4. Products derived from this Software may not be called "DOM4J" nor may
65   * "DOM4J" appear in their names without prior written permission of MetaStuff,
66   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
67   * 
68   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
69   * 
70   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
71   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
72   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
73   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
74   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
75   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
76   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
77   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
78   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
79   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
80   * POSSIBILITY OF SUCH DAMAGE.
81   * 
82   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
83   */