org.codenarc.util.io.ResourceFactory.groovy Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2009 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 org.codenarc.util.io

/**
 * Defines the interface for factory objects that create/return Resource instances.
 * 
 * This is an internal class and its API is subject to change.
 *
 * @author Chris Mair
  */
interface ResourceFactory {

    /**
     * Return a Resource instance suitable for the specified path.
     * @param path - the path to the resource. This may be optionally prefixed by 
     * @throws IOException - if an error occurs opening the InputStream
     */
    Resource getResource(String path) throws IOException
}