001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.mvnrepo;
020
021import java.nio.file.Path;
022import org.jdrupes.builder.api.ResourceFactory;
023import org.jdrupes.builder.api.ResourceType;
024import org.jdrupes.builder.java.JarFile;
025
026/// A [JarFile] that has been downloaded from a Maven repository.
027/// Unlike a [MvnRepoResource], a resource of this type represents a
028/// local file. This interface merely preserves information about the
029/// Maven repository resource from which it originated.
030/// 
031public interface MvnRepoJarFile extends JarFile {
032
033    /// Returns the Maven repository reference for this JAR file.
034    ///
035    /// @return the Maven repository resource
036    ///
037    MvnRepoResource reference();
038
039    /// Creates a new Maven repository JAR file resource from the given values.
040    ///
041    /// @param <T> the resource type
042    /// @param fileType the requested type
043    /// @param coordinates the coordinates
044    /// @param path the path
045    /// @return the maven repository jar file
046    ///
047    @SuppressWarnings("PMD.ShortMethodName")
048    static <T extends JarFile> T of(ResourceType<T> fileType,
049            String coordinates, Path path) {
050        return ResourceFactory.create(fileType, coordinates, path);
051    }
052}