LocationResolver.java

/*
 *    Copyright 2012 Jason Miller
 *
 * 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 jj.resource;

import java.nio.file.Path;
import java.util.List;

/**
 * @author jason
 *
 */
public interface LocationResolver {

	/**
	 * resolve the given location and name against
	 * the base path
	 */
	Path resolvePath(Location base, String name);
	
	Location resolveBase(Path path);
	
	/**
	 * enumerate the paths that this resolver wants watched for changes
	 */
	List<Location> watchedLocations();
	
	/**
	 * if there is an appropriate location for specs for a given
	 * location, return it, otherwise return null
	 * 
	 */
	Location specLocationFor(Location base);

	String normalizedName(Location originalBase, Location normalizedBase, String name);

}