View Javadoc

1   package org.apache.commons.digester3;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.xml.sax.Attributes;
23  
24  /**
25   * Defines a functor interface implemented by classes that perform a predicate test
26   *
27   * @since 3.0
28   */
29  public interface RuleMatcher
30  {
31  
32      /**
33       * Use the specified parameter to perform a test.
34       *
35       * @param namespace the namespace URI of the matching element, or an empty string if the parser is not namespace
36       *            aware or the element has no namespace
37       * @param pattern Nesting pattern to be matched for this Rule
38       * @param name the local name if the parser is namespace aware, or just the element name otherwise
39       * @param attributes The attribute list of this element
40       * @return true, if the test succeeds, false otherwise
41       */
42      boolean match( String namespace, String pattern, String name, Attributes attributes );
43  
44  }