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.SetRootRule;
29  import org.apache.commons.digester3.annotations.DigesterRule;
30  import org.apache.commons.digester3.annotations.handlers.SetRootHandler;
31  
32  /**
33   * Methods annotated with {@code SetRoot} will be bound with {@code SetRootRule} digester rule.
34   * 
35   * @see org.apache.commons.digester3.Digester#addSetRoot(String,String,String)
36   * @since 2.1
37   */
38  @Documented
39  @Retention( RetentionPolicy.RUNTIME )
40  @Target( ElementType.METHOD )
41  @DigesterRule( reflectsRule = SetRootRule.class, handledBy = SetRootHandler.class )
42  public @interface SetRoot
43  {
44  
45      /**
46       * Defines the concrete implementation(s) of @SetRoot annotated method argument.
47       */
48      Class<?>[] value() default { };
49  
50      /**
51       * Marks the rule be invoked when {@code begin} or {@code end} events match.
52       */
53      boolean fireOnBegin() default false;
54  
55  }