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.util.List;
017    import java.util.Map;
018    
019    /**
020     * Information about a ClassPath.
021     *   A ClassPath specifies a list of ClassElement(s).
022     *   A ClassElement specifies a list of ClassFiles(s).
023     */
024    public interface ClassPath {
025            /**
026             * Get the collection of file base locations specified by this instance 
027             */
028            List<? extends ClassPathElement> getClassPathElements();
029            
030            /**
031             * Get files with a particular name
032             * 
033             * @param fileName The name of the desired file (this may be a path such as META-INF/resources/com.example.group.interface)
034             * @return A Map of base locations as the keys and absolute file locations as the values
035             */
036            Map<ClassPathElement, ResourceFile> getResources(String fileName);
037    }