asset.pipeline.fs.AssetResolver.groovy Maven / Gradle / Ivy

/*
* Copyright 2014 the original author or authors.
*
* 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 asset.pipeline.fs

import asset.pipeline.*

/**
* A public interface defining a class that can resolve files
 *
* @author David Estes
*/
public interface AssetResolver {

	public String getName()

    /**
     * Resolves a file given a relative path to this particular resolver
     * @param relativePath The relative path to resolve the file from
     * @param contentType Optional contentType filter
     * @param extension The extension of the file if not in the relativePath
     * @param baseFile baseFile to be appended to resultant AssetFile object
     * @return The matched AssetFile instance (if not found null is returned)
     */
	public AssetFile getAsset(String relativePath, String contentType, String extension, AssetFile baseFile)

    /**
     * Resolves a file given a relative path to this particular resolver
     * @param relativePath The relative path to resolve the file from
     * @param contentType Optional contentType filter
     * @return The matched AssetFile instance (if not found null is returned)
     *
     * @see AssetResolver#getAsset(String,String,String,AssetFile)
     */
	public AssetFile getAsset(String relativePath, String contentType)

    /**
     * * Resolves a file given a relative path to this particular resolver
     * @param relativePath The relative path to resolve the file from
     * @return The matched AssetFile instance (if not found null is returned)
     *
     * * @see AssetResolver#getAsset(String,String,String,AssetFile)
     */
	public AssetFile getAsset(String relativePath)

	/**
	* Resolves multiple files given a basePath and content type
	* @param basePath String containing the base prefix path
	* @param contentType String containing the contentType filter
	* @param extension   String containing the target extension
	* @return AssetFile[] Returns a list of Asset Files
	*/
	public List getAssets(String basePath, String contentType, String extension,  Boolean recursive, AssetFile relativeFile, AssetFile baseFile)
	public List getAssets(String basePath, String contentType, String extension)
	public List getAssets(String basePath, String contentType)
	public List getAssets(String basePath)

	public Collection scanForFiles(List excludePatterns, List includePatterns)
}