View Javadoc
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  import java.nio.file.Path;
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 extends Metadata {
30  
31      /**
32       * Merges this metadata into the current metadata (if any). Note that this method will be invoked regardless whether
33       * metadata currently exists or not.
34       *
35       * @param current The path to the current metadata file, may not exist but must not be {@code null}.
36       * @param result The path to the result file where the merged metadata should be stored, must not be {@code null}.
37       * @throws RepositoryException If the metadata could not be merged.
38       * @deprecated Use {@link #merge(Path, Path)} instead.
39       */
40      @Deprecated
41      void merge(File current, File result) throws RepositoryException;
42  
43      /**
44       * Merges this metadata into the current metadata (if any). Note that this method will be invoked regardless whether
45       * metadata currently exists or not.
46       *
47       * @param current The path to the current metadata file, may not exist but must not be {@code null}.
48       * @param result The path to the result file where the merged metadata should be stored, must not be {@code null}.
49       * @throws RepositoryException If the metadata could not be merged.
50       * @since 2.0.0
51       */
52      default void merge(Path current, Path result) throws RepositoryException {
53          merge(current.toFile(), result.toFile());
54      }
55  
56      /**
57       * Indicates whether this metadata has been merged.
58       *
59       * @return {@code true} if the metadata has been merged, {@code false} otherwise.
60       */
61      boolean isMerged();
62  }