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.metadata;
20
21 import java.io.File;
22
23 import org.eclipse.aether.RepositoryException;
24
25 /**
26 * A piece of metadata that needs to be merged with any current metadata before installation/deployment.
27 */
28 public interface MergeableMetadata extends Metadata {
29
30 /**
31 * Merges this metadata into the current metadata (if any). Note that this method will be invoked regardless whether
32 * metadata currently exists or not.
33 *
34 * @param current The path to the current metadata file, may not exist but must not be {@code null}.
35 * @param result The path to the result file where the merged metadata should be stored, must not be {@code null}.
36 * @throws RepositoryException If the metadata could not be merged.
37 */
38 void merge(File current, File result) throws RepositoryException;
39
40 /**
41 * Indicates whether this metadata has been merged.
42 *
43 * @return {@code true} if the metadata has been merged, {@code false} otherwise.
44 */
45 boolean isMerged();
46 }