View Javadoc
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.Service;
23  import org.apache.maven.api.Session;
24  import org.apache.maven.api.annotations.Experimental;
25  import org.apache.maven.api.annotations.Nonnull;
26  
27  /**
28   * Service used to create {@link Artifact} objects.
29   *
30   * @since 4.0.0
31   */
32  @Experimental
33  public interface ArtifactFactory extends Service {
34  
35      /**
36       * Creates an artifact.
37       *
38       * @param request the request holding artifact creation parameters
39       * @return an {@code Artifact}, never {@code null}
40       * @throws IllegalArgumentException if {@code request} is null or {@code request.session} is null or invalid
41       */
42      @Nonnull
43      Artifact create(@Nonnull ArtifactFactoryRequest request);
44  
45      @Nonnull
46      default Artifact create(
47              @Nonnull Session session, String groupId, String artifactId, String version, String extension) {
48          return create(ArtifactFactoryRequest.build(session, groupId, artifactId, version, extension));
49      }
50  
51      @Nonnull
52      default Artifact create(
53              @Nonnull Session session,
54              String groupId,
55              String artifactId,
56              String version,
57              String classifier,
58              String extension,
59              String type) {
60          return create(ArtifactFactoryRequest.build(session, groupId, artifactId, version, classifier, extension, type));
61      }
62  }