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