cloud.piranha.resource.api.ResourceManager Maven / Gradle / Ivy
/*
* Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package cloud.piranha.resource.api;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;
/**
* The ResourceManager API.
*
* @author Manfred Riem ([email protected])
*/
public interface ResourceManager {
/**
* Add the resource.
*
* @param resource the resource.
*/
void addResource(Resource resource);
/**
* Get the resource.
*
* @param location the location.
* @return the URL.
* @throws MalformedURLException when the location is malformed.
*/
URL getResource(String location) throws MalformedURLException;
/**
* Get the resources.
*
* @param location the location
* @return the URLs.
* @throws MalformedURLException when the location is malformed.
*/
Collection getResources(String location) throws MalformedURLException;
/**
* Get the resource as a stream.
*
* @param location the location.
* @return the input stream, or null if not found.
*/
InputStream getResourceAsStream(String location);
/**
* {@return all the locations for this resource manager}
*/
Stream getAllLocations();
/**
* {@return all the locations for this resource manager}
*/
List getResourceList();
/**
* {@return isAlsoTryLoadFromClass}
*/
default boolean isAlsoTryLoadFromClass() {
return true;
}
/**
* Sets the alsoTryLoadFromClass flag
* @param alsoTryLoadFromClass the alsoTryLoadFromClass flag
*/
default void setAlsoTryLoadFromClass(boolean alsoTryLoadFromClass) {
}
}