/*

  * 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.apache.commons.classscan;

 import java.io.IOException;

 import java.io.InputStream;

 /**

  * Information about and access to a location that contains a class or a resource.

  * <br/>

  * IMPORTANT: Do not hold onto instances.  There maybe open file or network resources associated with these instances.

  */

 public interface ResourceFile {

         /**

          * Get the relative file name;

          * @return The resource name relative to the ClassPathElement base

          */

         String getFileName();

         /**

          * Get the stream of bytes for the resource.

          * 

          * @return The InputStream to read resource bytes.  This stream should be closed when all bytes have been read.

          */

         InputStream getBytes() throws IOException;

 }