001package 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
022import java.lang.annotation.Documented;
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Inherited;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import 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>.
033 *
034 * @author Olivier Lamy
035 * @since 3.0
036 */
037@Documented
038@Retention( RetentionPolicy.CLASS )
039@Target( { ElementType.FIELD } )
040@Inherited
041public @interface Component
042{
043    /**
044     * role of the component to inject.
045     * @return the role
046     */
047    Class<?> role() default Object.class;
048
049    /**
050     * hint of the component to inject.
051     * @return the hint
052     */
053    String hint() default "";
054}