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.api;
020
021import java.util.stream.Stream;
022
023/// The interface ResourceRetriever, see [Generator].
024///
025@SuppressWarnings("PMD.ImplicitFunctionalInterface")
026public interface ResourceRetriever {
027
028    /// Adds the given provider(s) as source for resources.
029    ///
030    /// @param providers the provider to add
031    /// @return the resource retriever
032    ///
033    default ResourceRetriever addFrom(ResourceProvider... providers) {
034        addFrom(Stream.of(providers));
035        return this;
036    }
037
038    /// Adds the given providers as sources for resources. The stream
039    /// must not be terminated before the generators' provide method
040    /// is invoked.
041    ///
042    /// @param providers the providers to retrieve resources from
043    /// @return the resource retriever
044    ///
045    ResourceRetriever addFrom(Stream<ResourceProvider> providers);
046
047}