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.services;
20
21 import org.apache.maven.api.Artifact;
22 import org.apache.maven.api.ProducedArtifact;
23 import org.apache.maven.api.Service;
24 import org.apache.maven.api.Session;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27
28 /**
29 * Service used to create {@link Artifact} objects.
30 *
31 * @since 4.0.0
32 */
33 @Experimental
34 public interface ArtifactFactory extends Service {
35
36 /**
37 * Creates an artifact.
38 *
39 * @param request the request holding artifact creation parameters
40 * @return an {@code Artifact}, never {@code null}
41 * @throws IllegalArgumentException if {@code request} is null or {@code request.session} is null or invalid
42 */
43 @Nonnull
44 Artifact create(@Nonnull ArtifactFactoryRequest request);
45
46 @Nonnull
47 default Artifact create(
48 @Nonnull Session session, String groupId, String artifactId, String version, String extension) {
49 return create(ArtifactFactoryRequest.build(session, groupId, artifactId, version, extension));
50 }
51
52 @Nonnull
53 default Artifact create(
54 @Nonnull Session session,
55 String groupId,
56 String artifactId,
57 String version,
58 String classifier,
59 String extension,
60 String type) {
61 return create(ArtifactFactoryRequest.build(session, groupId, artifactId, version, classifier, extension, type));
62 }
63
64 /**
65 * Creates an artifact.
66 *
67 * @param request the request holding artifact creation parameters
68 * @return an {@code Artifact}, never {@code null}
69 * @throws IllegalArgumentException if {@code request} is null or {@code request.session} is null or invalid
70 */
71 @Nonnull
72 ProducedArtifact createProduced(@Nonnull ArtifactFactoryRequest request);
73
74 @Nonnull
75 default ProducedArtifact createProduced(
76 @Nonnull Session session, String groupId, String artifactId, String version, String extension) {
77 return createProduced(ArtifactFactoryRequest.build(session, groupId, artifactId, version, extension));
78 }
79
80 @Nonnull
81 default ProducedArtifact createProduced(
82 @Nonnull Session session,
83 String groupId,
84 String artifactId,
85 String version,
86 String classifier,
87 String extension,
88 String type) {
89 return createProduced(
90 ArtifactFactoryRequest.build(session, groupId, artifactId, version, classifier, extension, type));
91 }
92 }