Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ClassPath |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
3 | * you may not use this file except in compliance with the License. | |
4 | * You may obtain a copy of the License at | |
5 | * | |
6 | * http://www.apache.org/licenses/LICENSE-2.0 | |
7 | * | |
8 | * Unless required by applicable law or agreed to in writing, software | |
9 | * distributed under the License is distributed on an "AS IS" BASIS, | |
10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
11 | * See the License for the specific language governing permissions and | |
12 | * limitations under the License. | |
13 | */ | |
14 | package org.apache.commons.classscan; | |
15 | ||
16 | import java.util.List; | |
17 | import java.util.Map; | |
18 | ||
19 | /** | |
20 | * Information about a ClassPath. | |
21 | * A ClassPath specifies a list of ClassElement(s). | |
22 | * A ClassElement specifies a list of ClassFiles(s). | |
23 | */ | |
24 | public interface ClassPath { | |
25 | /** | |
26 | * Get the collection of file base locations specified by this instance | |
27 | */ | |
28 | List<? extends ClassPathElement> getClassPathElements(); | |
29 | ||
30 | /** | |
31 | * Get files with a particular name | |
32 | * | |
33 | * @param fileName The name of the desired file (this may be a path such as META-INF/resources/com.example.group.interface) | |
34 | * @return A Map of base locations as the keys and absolute file locations as the values | |
35 | */ | |
36 | Map<ClassPathElement, ResourceFile> getResources(String fileName); | |
37 | } |