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