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.util.Optional;
022import org.jdrupes.builder.api.FileTree;
023import org.jdrupes.builder.api.Project;
024import static org.jdrupes.builder.api.Project.Properties.Version;
025import org.jdrupes.builder.api.ResourceRequest;
026import org.jdrupes.builder.api.ResourceType;
027import org.jdrupes.builder.java.JarGenerator;
028import org.jdrupes.builder.java.JavaSourceFile;
029import static org.jdrupes.builder.java.JavaTypes.SourcesJarFileType;
030import static org.jdrupes.builder.mvnrepo.MvnProperties.*;
031
032/// A special [JarGenerator] that generates a sources jar following
033/// the maven convention.
034///
035///   * The content of the jar is obtained by requesting [FileTree]s
036///     with [JavaSourceFile]s from the project's suppliers.
037///
038///   * The name of the jar is set to `<artifactId>-<version>-sources.jar`,
039///     where `<artifactId>` is the value of the project's property 
040///     [MvnProperties#ArtifactId] with a fallback to the project's name.
041///     `<version>` is the value of the project's property
042///     [Project.Properties#Version].
043///
044public class SourcesJarGenerator extends JarGenerator {
045
046    /// Initializes a new sources jar generator.
047    ///
048    /// @param project the project
049    ///
050    @SuppressWarnings("PMD.ConstructorCallsOverridableMethod")
051    public SourcesJarGenerator(Project project) {
052        super(project, SourcesJarFileType);
053        addTrees(project().supplied(
054            new ResourceRequest<FileTree<JavaSourceFile>>(
055                new ResourceType<>() {})));
056        jarName(Optional.ofNullable(project().get(ArtifactId))
057            .orElse(project().name()) + "-" + project().get(Version)
058            + "-sources.jar");
059    }
060
061}