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