org.spongepowered.api.resource.ResourceManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
There is a newer version: 9.0.0
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.resource;

import org.spongepowered.api.resource.pack.PackContents;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Collection;
import java.util.function.Predicate;
import java.util.stream.Stream;

/**
 * The resource manager is in charge of loading {@link Resource Resources}.
 *
 * Packs are stacked on top of each other, so they will override and replace
 * resources in packs which are a lower priority.
 */
public interface ResourceManager {

    /**
     * Loads the {@link Resource resource} at the given path, or throws an
     * exception if it doesn't exist.
     *
     * @param path The path to the resource
     * @return The resource
     * @throws IOException If the resource could not be read
     * @throws FileNotFoundException If the file does not exist
     */
    Resource load(ResourcePath path) throws IOException;

    /**
     * Loads all the {@link Resource resources} at the given path from all
     * active {@link PackContents pack contents}.
     *
     * @param path The path to the resource
     * @return The list of all resources at the path
     * @throws IOException If a resource could not be read
     * @throws FileNotFoundException If there are no resources at the path
     */
    Stream streamAll(ResourcePath path) throws IOException;

    /**
     * Finds all the {@link ResourcePath resource paths} from all namespaces
     * with the given path prefix and matches the filter {@link Predicate}.
     *
     * @param pathPrefix The prefix of the paths
     * @param pathFilter The filter all paths must pass
     * @return The list of matching paths
     */
    Collection find(String pathPrefix, Predicate pathFilter);

}