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.ObjectCreateRule;
29  import org.apache.commons.digester3.annotations.DigesterRule;
30  import org.apache.commons.digester3.annotations.DigesterRuleList;
31  import org.apache.commons.digester3.annotations.handlers.ObjectCreateHandler;
32  
33  /**
34   * Classes annotated with {@code ObjectCreate} will be bound with {@code ObjectCreateRule} digester rule.
35   *
36   * @see org.apache.commons.digester3.Digester#addObjectCreate(String,Class)
37   * @since 2.1
38   */
39  @Documented
40  @Retention( RetentionPolicy.RUNTIME )
41  @Target( { ElementType.CONSTRUCTOR, ElementType.TYPE } )
42  @CreationRule
43  @DigesterRule( reflectsRule = ObjectCreateRule.class, handledBy = ObjectCreateHandler.class )
44  public @interface ObjectCreate
45  {
46  
47      /**
48       * The element matching pattern.
49       */
50      String pattern();
51  
52      /**
53       * The namespace URI for which this Rule is relevant, if any.
54       *
55       * @since 3.0
56       */
57      String namespaceURI() default "";
58  
59      /**
60       * Allows specify the attribute containing an override class name if it is present.
61       *
62       * @since 3.0
63       */
64      String attributeName() default "";
65  
66      /**
67       * Defines several {@code @ObjectCreate} annotations on the same element.
68       *
69       * @see ObjectCreate
70       */
71      @Documented
72      @Retention( RetentionPolicy.RUNTIME )
73      @Target( ElementType.TYPE )
74      @DigesterRuleList
75      @interface List
76      {
77          ObjectCreate[] value();
78      }
79  
80  }