IResourceLocator.java

/*
 * Copyright 2009-11 www.scribble.org
 *
 * 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 org.scribble.main.resource;

import java.nio.file.Path;

import org.scribble.main.ScribbleException;


/**
 * This interface provides the resource location capability.
 *
 */
public interface IResourceLocator
{
	/**
	 * This method obtains the resource associated with the
	 * supplied path.
	 * 
	 * @param path The resource path -- "relative" path from import path prefixes
	 * @return The resource, or null if not found
	 */

	Resource getResource(Path path) throws ScribbleException;  // Path should be made more abstract, e.g. some kind of URI (cf., Resource.getLocation)
}