View Javadoc
1   /*
2    * Copyright (C) 2007 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.codehaus.plexus.component.annotations;
18  
19  import java.lang.annotation.Documented;
20  import static java.lang.annotation.ElementType.FIELD;
21  import static java.lang.annotation.ElementType.METHOD;
22  import java.lang.annotation.Inherited;
23  import java.lang.annotation.Retention;
24  import static java.lang.annotation.RetentionPolicy.RUNTIME;
25  import java.lang.annotation.Target;
26  
27  /**
28   * Configures a requirement.
29   *
30   * @since 1.0-alpha-33
31   * @version $Id$
32   */
33  @Documented
34  @Retention(RUNTIME)
35  @Target({ FIELD, METHOD })
36  @Inherited
37  public @interface Requirement
38  {
39      Class<?> role() default Object.class;
40  
41      String hint() default "";
42  
43      //
44      // HACK: This is here to support component requirement lists, which can take a list of hints
45      //
46  
47      String[] hints() default {};
48  
49      boolean optional() default false;
50  
51  }