001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.plugins.annotations;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Inherited;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * Used to configure injection of Plexus components by
030 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html">
031 * <code>MavenPluginManager.getConfiguredMojo(...)</code></a>.
032 *
033 * @author Olivier Lamy
034 * @since 3.0
035 * @deprecated Use <a href="https://maven.apache.org/maven-jsr330.html#how-to-use-jsr-330-in-plugins">JSR 330 annotations</a> or {@link Parameter} with according default expressions instead.
036 */
037@Documented
038@Retention(RetentionPolicy.CLASS)
039@Target({ElementType.FIELD})
040@Inherited
041@Deprecated
042public @interface Component {
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}