001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.artifact.generator;
020
021import java.util.Collection;
022
023import org.eclipse.aether.artifact.Artifact;
024
025/**
026 * An artifact generator that participates in the installation/deployment of artifacts.
027 *
028 * @since 2.0.0
029 */
030public interface ArtifactGenerator extends AutoCloseable {
031    /**
032     * Returns the generator ID, never {@code null}.
033     */
034    String generatorId();
035
036    /**
037     * Generates artifacts.
038     *
039     * @param generatedArtifacts The generated artifacts so far.
040     * @return The additional artifacts to install/deploy, never {@code null}.
041     */
042    Collection<? extends Artifact> generate(Collection<? extends Artifact> generatedArtifacts);
043
044    /**
045     * Invoked when generator use is done.
046     */
047    @Override
048    void close();
049}