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.eclipse.aether.spi.artifact.generator;
20
21 import java.util.Collection;
22
23 import org.eclipse.aether.artifact.Artifact;
24
25 /**
26 * An artifact generator that participates in the installation/deployment of artifacts.
27 *
28 * @since 2.0.0
29 */
30 public interface ArtifactGenerator extends AutoCloseable {
31 /**
32 * Returns the generator ID, never {@code null}.
33 */
34 String generatorId();
35
36 /**
37 * Generates artifacts.
38 *
39 * @param generatedArtifacts The generated artifacts so far.
40 * @return The additional artifacts to install/deploy, never {@code null}.
41 */
42 Collection<? extends Artifact> generate(Collection<? extends Artifact> generatedArtifacts);
43
44 /**
45 * Invoked when generator use is done.
46 */
47 @Override
48 void close();
49 }