1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.rat.config.parameters;
20
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 /**
27 * An annotation that marks a configuration component.
28 *
29 */
30 @Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
31 @Retention(RetentionPolicy.RUNTIME)
32 public @interface ConfigComponent {
33 /**
34 * The common name for the component. If not specified the name of the field or class is used.
35 * @return the component name.
36 */
37 String name() default "";
38
39 /**
40 * The description of the component.
41 * @return the component description.
42 */
43 String desc() default "";
44 /**
45 * The component type
46 * @return the component type.
47 */
48 ComponentType type();
49
50 /**
51 * For collections defines the enclosed type.
52 * @return the enclosed type.
53 */
54 Class<?> parameterType() default void.class;
55
56 /**
57 * if {@code true} this component can be child of the containing component
58 * @return {@code true} if this component can be child of the containing component
59 */
60 boolean required() default false;
61 }