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  import org.dom4j.Element;
13  import org.dom4j.QName;
14  
15  /***
16   * <p>
17   * <code>ElementQNameIterator</code> is a filtering {@link Iterator}which
18   * filters out objects which do not implement the {@link Element}interface and
19   * are not of the correct fully qualified element name.
20   * </p>
21   * 
22   * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
23   * @version $Revision: 1.7 $
24   * 
25   * @deprecated THIS CLASS WILL BE REMOVED IN dom4j-1.6 !!
26   */
27  public class ElementQNameIterator extends FilterIterator {
28      private QName qName;
29  
30      public ElementQNameIterator(Iterator proxy, QName qName) {
31          super(proxy);
32          this.qName = qName;
33      }
34  
35      /***
36       * DOCUMENT ME!
37       * 
38       * @param object
39       *            DOCUMENT ME!
40       * 
41       * @return true if the given element implements the {@link Element}
42       *         interface and matches the given {@link QName}
43       */
44      protected boolean matches(Object object) {
45          if (object instanceof Element) {
46              Element element = (Element) object;
47  
48              return qName.equals(element.getQName());
49          }
50  
51          return false;
52      }
53  }
54  
55  /*
56   * Redistribution and use of this software and associated documentation
57   * ("Software"), with or without modification, are permitted provided that the
58   * following conditions are met:
59   * 
60   * 1. Redistributions of source code must retain copyright statements and
61   * notices. Redistributions must also contain a copy of this document.
62   * 
63   * 2. Redistributions in binary form must reproduce the above copyright notice,
64   * this list of conditions and the following disclaimer in the documentation
65   * and/or other materials provided with the distribution.
66   * 
67   * 3. The name "DOM4J" must not be used to endorse or promote products derived
68   * from this Software without prior written permission of MetaStuff, Ltd. For
69   * written permission, please contact dom4j-info@metastuff.com.
70   * 
71   * 4. Products derived from this Software may not be called "DOM4J" nor may
72   * "DOM4J" appear in their names without prior written permission of MetaStuff,
73   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
74   * 
75   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
76   * 
77   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
78   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
79   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
80   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
81   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
82   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
83   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
84   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
85   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
86   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
87   * POSSIBILITY OF SUCH DAMAGE.
88   * 
89   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
90   */