View Javadoc

1   package org.apache.commons.digester3.annotations.rules;
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 java.lang.annotation.Documented;
23  import java.lang.annotation.ElementType;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  import org.apache.commons.digester3.SetTopRule;
29  import org.apache.commons.digester3.annotations.DigesterRule;
30  import org.apache.commons.digester3.annotations.DigesterRuleList;
31  import org.apache.commons.digester3.annotations.handlers.SetTopHandler;
32  
33  /**
34   * Methods annotated with {@code SetTop} will be bound with {@code SetTopRule} digester rule.
35   *
36   * @see org.apache.commons.digester3.Digester#addSetTop(String,String,String)
37   * @since 2.1
38   */
39  @Documented
40  @Retention( RetentionPolicy.RUNTIME )
41  @Target( ElementType.METHOD )
42  @DigesterRule( reflectsRule = SetTopRule.class, handledBy = SetTopHandler.class )
43  public @interface SetTop
44  {
45  
46      /**
47       * The element matching pattern.
48       */
49      String pattern();
50  
51      /**
52       * Marks the rule be invoked when {@code begin} or {@code end} events match.
53       */
54      boolean fireOnBegin() default false;
55  
56      /**
57       * The namespace URI for which this Rule is relevant, if any.
58       *
59       * @since 3.0
60       */
61      String namespaceURI() default "";
62  
63      /**
64       * Defines several {@code @SetTop} annotations on the same element
65       *
66       * @see SetTop
67       */
68      @Documented
69      @Retention( RetentionPolicy.RUNTIME )
70      @Target( ElementType.METHOD )
71      @DigesterRuleList
72      @interface List
73      {
74          SetTop[] value();
75      }
76  
77  }