org.gmetrics.util.io.Resource.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gmetrics Show documentation

The GMetrics project provides calculation and reporting of size and complexity metrics for Groovy source code.

The newest version!

/*
 * 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.gmetrics.util.io

/**
 * Defines the interface for objects that represent a resource (e.g. a file) and
 * provide access to its InputStream.
 * 
 * The design of this (resource) framework is heavily influenced by the Resource classes 
 * within The Spring Framework.
 * 
 * This is an internal class and its API is subject to change.
 *
 * @author Chris Mair
 * @version $Revision$ - $Date$
 */
interface Resource {

    /**
     * Return the InputStream for this resource.
     * @throws IOException - if an error occurs opening the InputStream
     */
    InputStream getInputStream() throws IOException
}