1 package org.eclipse.aether.impl; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.util.Collection; 23 24 import org.eclipse.aether.artifact.Artifact; 25 import org.eclipse.aether.metadata.Metadata; 26 27 /** 28 * A metadata generator that participates in the installation/deployment of artifacts. 29 * 30 * @provisional This type is provisional and can be changed, moved or removed without prior notice. 31 */ 32 public interface MetadataGenerator 33 { 34 35 /** 36 * Prepares the generator to transform artifacts. 37 * 38 * @param artifacts The artifacts to install/deploy, must not be {@code null}. 39 * @return The metadata to process (e.g. merge with existing metadata) before artifact transformations, never 40 * {@code null}. 41 */ 42 Collection<? extends Metadata> prepare( Collection<? extends Artifact> artifacts ); 43 44 /** 45 * Enables the metadata generator to transform the specified artifact. 46 * 47 * @param artifact The artifact to transform, must not be {@code null}. 48 * @return The transformed artifact (or just the input artifact), never {@code null}. 49 */ 50 Artifact transformArtifact( Artifact artifact ); 51 52 /** 53 * Allows for metadata generation based on the transformed artifacts. 54 * 55 * @param artifacts The (transformed) artifacts to install/deploy, must not be {@code null}. 56 * @return The additional metadata to process after artifact transformations, never {@code null}. 57 */ 58 Collection<? extends Metadata> finish( Collection<? extends Artifact> artifacts ); 59 60 }