001/*
002 * JDrupes Builder
003 * Copyright (C) 2025, 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.java;
020
021import java.nio.file.Path;
022import org.jdrupes.builder.api.FileTree;
023import org.jdrupes.builder.api.Project;
024import org.jdrupes.builder.api.ResourceFactory;
025import org.jdrupes.builder.api.ResourceFile;
026import static org.jdrupes.builder.java.JavaTypes.JavaResourceTreeType;
027
028/// A [FileTree] that consists of [ResourceFile]s and can be used in
029/// a Java classpath.
030///
031public interface JavaResourceTree
032        extends FileTree<ResourceFile>, CodeContribution {
033
034    @Override
035    default boolean isModular() {
036        return false;
037    }
038
039    /// Creates a new Java resource tree from the given values.
040    ///
041    /// @param project the project
042    /// @param directory the directory
043    /// @param pattern the pattern
044    /// @return the java resource tree
045    ///
046    @SuppressWarnings("PMD.ShortMethodName")
047    static JavaResourceTree of(Project project, Path directory,
048            String pattern) {
049        return ResourceFactory.create(JavaResourceTreeType, project, directory,
050            new String[] { pattern });
051    }
052}