DownloadedArtifact.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.api;

import java.nio.file.Path;

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;

/**
 * An {@link Artifact} that has been resolved, i.e. downloaded to the local repository.
 *
 * @since 4.0.0
 */
@Experimental
@Immutable
public interface DownloadedArtifact extends Artifact {

    /**
     * {@return the a path to the file that has been downloaded to the file system}.
     */
    Path path();

    /**
     * {@return the a path to the file that has been downloaded to the file system}.
     *
     * @deprecated Use {@link #path()} instead.
     */
    @Deprecated(since = "4.1.0", forRemoval = true)
    default Path getPath() {
        return path();
    }
}