001 package org.apache.maven.plugins.annotations; 002 003 /* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022 import java.lang.annotation.Documented; 023 import java.lang.annotation.ElementType; 024 import java.lang.annotation.Inherited; 025 import java.lang.annotation.Retention; 026 import java.lang.annotation.RetentionPolicy; 027 import java.lang.annotation.Target; 028 029 /** 030 * Used to configure injection of Plexus components by 031 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html"> 032 * <code>MavenPluginManager.getConfiguredMojo(...)</code></a> and special Maven 033 * objects as well: 034 * <dl> 035 * <dt>mojoExecution</dt> <dd>org.apache.maven.plugin.MojoExecution</dd> 036 * <dt>project</dt> <dd>org.apache.maven.project.MavenProject</dd> 037 * <dt>session</dt> <dd>org.apache.maven.execution.MavenSession</dd> 038 * <dt>settings</dt> <dd>org.apache.maven.settings.Settings</dd> 039 * <dt>plugin (Maven-3 only)</dt><dd>org.apache.maven.plugin.descriptor.PluginDescriptor</dd> 040 * </dl> 041 * 042 * @author Olivier Lamy 043 * @since 3.0 044 */ 045 @Documented 046 @Retention( RetentionPolicy.CLASS ) 047 @Target( { ElementType.FIELD } ) 048 @Inherited 049 public @interface Component 050 { 051 /** 052 * role of the component to inject. 053 * @return the role 054 */ 055 Class<?> role() default Object.class; 056 057 /** 058 * hint of the component to inject. 059 * @return the hint 060 */ 061 String hint() default ""; 062 }