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;
20
21 import java.util.Map;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Immutable;
25 import org.apache.maven.api.annotations.Nonnull;
26 import org.apache.maven.api.model.PluginContainer;
27
28 /**
29 * Interface representing a Maven project packaging.
30 * <p>
31 * TODO: define how to plug in new packaging definitions using the SPI.
32 * the packaging are currently defined by Maven 3 {@code Provider<LifecycleMapping>}
33 *
34 * @since 4.0.0
35 */
36 @Experimental
37 @Immutable
38 public interface Packaging extends ExtensibleEnum {
39 /**
40 * The packaging id.
41 */
42 @Nonnull
43 String id();
44
45 /**
46 * The language of this packaging.
47 */
48 @Nonnull
49 default Language language() {
50 return type().getLanguage();
51 }
52
53 /**
54 * The type of main artifact produced by this packaging.
55 */
56 @Nonnull
57 Type type();
58
59 /**
60 * Returns the binding to use specifically for this packaging keyed by lifecycle id.
61 * This will be used instead of the default packaging definition.
62 */
63 @Nonnull
64 Map<String, PluginContainer> plugins();
65 }