001    /*
002     * Licensed under the Apache License, Version 2.0 (the "License");
003     * you may not use this file except in compliance with the License.
004     * You may obtain a copy of the License at
005     *
006     *      http://www.apache.org/licenses/LICENSE-2.0
007     *
008     * Unless required by applicable law or agreed to in writing, software
009     * distributed under the License is distributed on an "AS IS" BASIS,
010     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011     * See the License for the specific language governing permissions and
012     * limitations under the License.
013     */
014    package org.apache.commons.classscan;
015    
016    import java.io.IOException;
017    import java.io.InputStream;
018    
019    /**
020     * Information about and access to a location that contains a class or a resource.
021     * <br/>
022     * IMPORTANT: Do not hold onto instances.  There maybe open file or network resources associated with these instances.
023     */
024    public interface ResourceFile {
025            /**
026             * Get the relative file name;
027             * @return The resource name relative to the ClassPathElement base
028             */
029            String getFileName();
030            
031            /**
032             * Get the stream of bytes for the resource.
033             * 
034             * @return The InputStream to read resource bytes.  This stream should be closed when all bytes have been read.
035             */
036            InputStream getBytes() throws IOException;
037    }