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.FileResource;
023import org.jdrupes.builder.api.FileTree;
024import static org.jdrupes.builder.api.Intent.Supply;
025import org.jdrupes.builder.api.Project;
026import static org.jdrupes.builder.api.Project.Properties.Version;
027import org.jdrupes.builder.api.ResourceType;
028import org.jdrupes.builder.java.JarBuilder;
029import static org.jdrupes.builder.java.JavaTypes.*;
030import org.jdrupes.builder.java.JavadocDirectory;
031import static org.jdrupes.builder.mvnrepo.MvnProperties.*;
032
033/// A special [JarBuilder] that generates a jar with javadoc.
034///
035///   * The content of the jar is obtained by requesting resources of
036///     type [JavadocDirectory] from the project's suppliers and using
037///     each as root for a [FileTree], which is then added to the jar.
038///
039///   * The name of the jar is set to `<artifactId>-<version>-javadoc.jar`,
040///     where `<artifactId>` is the value of the project's property 
041///     [MvnProperties#ArtifactId] with a fallback to the project's name.
042///     `<version>` is the value of the project's property
043///     [Project.Properties#Version].
044///
045public class JavadocJarGenerator extends JarBuilder {
046
047    /// Initializes a new sources jar generator.
048    ///
049    /// @param project the project
050    ///
051    @SuppressWarnings({ "PMD.ConstructorCallsOverridableMethod" })
052    public JavadocJarGenerator(Project project) {
053        super(project, JavadocJarFileType);
054        var trees = project().resources(
055            of(JavadocDirectory.class).using(Supply)).map(
056                d -> project().newResource(
057                    new ResourceType<FileTree<FileResource>>() {},
058                    d.path(), "**/*"));
059        addTrees(trees);
060        jarName(Optional.ofNullable(project().get(ArtifactId))
061            .orElse(project().name()) + "-" + project().get(Version)
062            + "-javadoc.jar");
063    }
064
065}