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> and special Maven
33 * objects as well:
34 * <dl>
35 * <dt>mojoExecution</dt> <dd>org.apache.maven.plugin.MojoExecution</dd>
36 * <dt>project</dt> <dd>org.apache.maven.project.MavenProject</dd>
37 * <dt>session</dt> <dd>org.apache.maven.execution.MavenSession</dd>
38 * <dt>settings</dt> <dd>org.apache.maven.settings.Settings</dd>
39 * <dt>plugin (Maven-3 only)</dt><dd>org.apache.maven.plugin.descriptor.PluginDescriptor</dd>
40 * </dl>
41 *
42 * @author Olivier Lamy
43 * @since 3.0
44 */
45 @Documented
46 @Retention( RetentionPolicy.CLASS )
47 @Target( { ElementType.FIELD } )
48 @Inherited
49 public @interface Component
50 {
51 /**
52 * role of the component to inject.
53 * @return the role
54 */
55 Class<?> role() default Object.class;
56
57 /**
58 * hint of the component to inject.
59 * @return the hint
60 */
61 String hint() default "";
62 }