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