io.continual.resources.ResourceSource Maven / Gradle / Ivy

Go to download
/*
 *	Copyright 2019, Continual.io
 *
 *	Licensed under the Apache License, Version 2.0 (the "License");
 *	you may not use this file except in compliance with the License.
 *	You may obtain a copy of the License at
 *	
 *	http://www.apache.org/licenses/LICENSE-2.0
 *	
 *	Unless required by applicable law or agreed to in writing, software
 *	distributed under the License is distributed on an "AS IS" BASIS,
 *	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *	See the License for the specific language governing permissions and
 *	limitations under the License.
 */

 package io.continual.resources;

import java.io.IOException;
import java.io.InputStream;

public interface ResourceSource
{
	/**
	 * Does the resource ID possibly qualify as served by this source?
	 * @param resourceId
	 * @return true if the resource ID might be handled by this source
	 */
	default boolean qualifies ( String resourceId ) { return true; }

	/**
	 * Attempt to load the named resource.
	 * @param resourceId
	 * @return the resource as a stream, or null if it does not exist in this source
	 * @throws IOException 
	 */
	InputStream loadResource ( String resourceId ) throws IOException;
}