View Javadoc
1   package org.apache.maven.plugins.annotations;
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.Inherited;
25  import java.lang.annotation.Retention;
26  import java.lang.annotation.RetentionPolicy;
27  import java.lang.annotation.Target;
28  
29  /**
30   * Used to configure injection of Plexus components by
31   * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html">
32   * <code>MavenPluginManager.getConfiguredMojo(...)</code></a>.
33   *
34   * @author Olivier Lamy
35   * @since 3.0
36   */
37  @Documented
38  @Retention( RetentionPolicy.CLASS )
39  @Target( { ElementType.FIELD } )
40  @Inherited
41  public @interface Component
42  {
43      /**
44       * role of the component to inject.
45       * @return the role
46       */
47      Class<?> role() default Object.class;
48  
49      /**
50       * hint of the component to inject.
51       * @return the hint
52       */
53      String hint() default "";
54  }