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.nio.file.Path;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Immutable;
25
26 /**
27 * An {@link Artifact} that is being produced by a {@link Project} during the build.
28 *
29 * <p>Produced artifacts includes:</p><ul>
30 * <li>{@linkplain Project#getPomArtifact() the project POM artifact}</li>
31 * <li>{@linkplain Project#getMainArtifact() the main artifact}</li>
32 * <li>{@linkplain org.apache.maven.api.services.ProjectManager#attachArtifact(Session, Project, Path) artifacts to be attached to a project}</li>
33 * </ul>
34 *
35 * <p>For the main artifact and attached artifacts, the
36 * {@link org.apache.maven.api.services.ArtifactManager ArtifactManager} service must be used
37 * to point the artifact to a {@link Path} during the packaging phase.</p>
38 *
39 * @since 4.0.0
40 * @see Project#getMainArtifact()
41 * @see Project#getPomArtifact()
42 * @see org.apache.maven.api.services.ProjectManager#attachArtifact(Session, Project, Path)
43 * @see org.apache.maven.api.services.ArtifactManager#setPath(ProducedArtifact, Path)
44 */
45 @Experimental
46 @Immutable
47 public interface ProducedArtifact extends Artifact {}