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;
9   
10  /***
11   * <p>
12   * <code>NodeFilter</code> defines the behavior for a filter or predicate
13   * which acts on a DOM4J Node. Instances can be generated from an {@link
14   * DocumentFactory}.
15   * </p>
16   * 
17   * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
18   * @version $Revision: 1.7 $
19   */
20  public interface NodeFilter {
21      /***
22       * <p>
23       * <code>matches</code> returns true if the given node matches the filter
24       * condition.
25       * </p>
26       * 
27       * @param node
28       *            DOCUMENT ME!
29       * 
30       * @return true if this filter matches the given node
31       */
32      boolean matches(Node node);
33  }
34  
35  /*
36   * Redistribution and use of this software and associated documentation
37   * ("Software"), with or without modification, are permitted provided that the
38   * following conditions are met:
39   * 
40   * 1. Redistributions of source code must retain copyright statements and
41   * notices. Redistributions must also contain a copy of this document.
42   * 
43   * 2. Redistributions in binary form must reproduce the above copyright notice,
44   * this list of conditions and the following disclaimer in the documentation
45   * and/or other materials provided with the distribution.
46   * 
47   * 3. The name "DOM4J" must not be used to endorse or promote products derived
48   * from this Software without prior written permission of MetaStuff, Ltd. For
49   * written permission, please contact dom4j-info@metastuff.com.
50   * 
51   * 4. Products derived from this Software may not be called "DOM4J" nor may
52   * "DOM4J" appear in their names without prior written permission of MetaStuff,
53   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
54   * 
55   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
56   * 
57   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
58   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
61   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
62   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
63   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
64   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
65   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
66   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
67   * POSSIBILITY OF SUCH DAMAGE.
68   * 
69   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
70   */