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.api.annotations;
20
21 import java.lang.annotation.Documented;
22 import java.lang.annotation.ElementType;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26
27 /**
28 * A type implemented by, or extended by maven plugins or extensions.
29 * Maven plugins or extensions may provide implementations of those types which will be used by maven.
30 * <p>
31 * A type can be marked {@link Consumer} or {@link Provider} but not both. A type is assumed to be
32 * {@link Consumer} if it is not marked either {@link Consumer} or {@link Provider}.
33 * <p>
34 * A package can be marked {@link Provider}. In this case, all types in the package are considered
35 * to be a provider type regardless of whether they are marked {@link Consumer} or {@link Provider}.
36 *
37 * @see Provider
38 * @since 4.0
39 */
40 @Experimental
41 @Documented
42 @Retention(RetentionPolicy.CLASS)
43 @Target({ElementType.TYPE, ElementType.PACKAGE})
44 public @interface Consumer {}