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.java;
020
021import java.nio.file.Path;
022import org.jdrupes.builder.api.DocumentationDirectory;
023import org.jdrupes.builder.api.FileResource;
024import org.jdrupes.builder.api.Project;
025import org.jdrupes.builder.api.ResourceFactory;
026import org.jdrupes.builder.api.ResourceType;
027
028/// A [FileResource] that represents a directory generated by javadoc.
029///
030public interface JavadocDirectory extends DocumentationDirectory {
031
032    /// Creates a new javadoc directory resource from the given
033    /// project and path.
034    ///
035    /// @param project the project
036    /// @param path the path relative to the project's directory (or an
037    /// absolute path)
038    /// @param patterns the patterns. If no patterns are given, the
039    /// default pattern "**/*" is used
040    /// @return the file resource
041    ///
042    @SuppressWarnings("PMD.ShortMethodName")
043    static JavadocDirectory of(Project project, Path path, String... patterns) {
044        return ResourceFactory.create(new ResourceType<>() {},
045            project != null ? project.directory().resolve(path) : path,
046            (Object) patterns);
047    }
048}