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.metadata;
020
021import java.io.File;
022import java.nio.file.Path;
023
024import org.eclipse.aether.RepositoryException;
025
026/**
027 * A piece of metadata that needs to be merged with any current metadata before installation/deployment.
028 */
029public interface MergeableMetadata extends Metadata {
030
031    /**
032     * Merges this metadata into the current metadata (if any). Note that this method will be invoked regardless whether
033     * metadata currently exists or not.
034     *
035     * @param current The path to the current metadata file, may not exist but must not be {@code null}.
036     * @param result The path to the result file where the merged metadata should be stored, must not be {@code null}.
037     * @throws RepositoryException If the metadata could not be merged.
038     * @deprecated Use {@link #merge(Path, Path)} instead.
039     */
040    @Deprecated
041    void merge(File current, File result) throws RepositoryException;
042
043    /**
044     * Merges this metadata into the current metadata (if any). Note that this method will be invoked regardless whether
045     * metadata currently exists or not.
046     *
047     * @param current The path to the current metadata file, may not exist but must not be {@code null}.
048     * @param result The path to the result file where the merged metadata should be stored, must not be {@code null}.
049     * @throws RepositoryException If the metadata could not be merged.
050     * @since 2.0.0
051     */
052    default void merge(Path current, Path result) throws RepositoryException {
053        merge(current.toFile(), result.toFile());
054    }
055
056    /**
057     * Indicates whether this metadata has been merged.
058     *
059     * @return {@code true} if the metadata has been merged, {@code false} otherwise.
060     */
061    boolean isMerged();
062}