001/* 
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.rendering.api;
023
024import java.io.File;
025import java.net.URL;
026
027/**
028 * Resource locators are used to resolve resource names to resource URLs
029 *
030 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
031 */
032public interface ResourceLocator {
033
034    /**
035     * Gets an URL resource given a key
036     *
037     * @param key the resource key
038     * @return the resource URL or null if no such result was found
039     */
040    URL getResourceURL(String key);
041
042    /**
043     * Get a file resource given a key
044     *
045     * @param key
046     * @return
047     */
048    File getResourceFile(String key);
049
050}