Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ResourceIndexer |
|
| 1.0;1 |
1 | package org.jbehave.core.io.rest; | |
2 | ||
3 | import java.util.Map; | |
4 | ||
5 | /** | |
6 | * Indexes the resources available from the REST root URI. The index is represented | |
7 | * as a map, indexed by the name of the resource. | |
8 | * | |
9 | * @author Mauro Talevi | |
10 | */ | |
11 | public interface ResourceIndexer { | |
12 | ||
13 | /** | |
14 | * Indexes resources retrieved from the given root URI | |
15 | * | |
16 | * @param rootURI the root URI | |
17 | * @return The Map of index Resource objects | |
18 | */ | |
19 | Map<String, Resource> indexResources(String rootURI); | |
20 | ||
21 | /** | |
22 | * Indexes resources found in the given root path | |
23 | * | |
24 | * @param rootURI the root URI | |
25 | * @param rootPath the root path of the resources to index | |
26 | * @param syntax the syntax of the resources to index. Can be <code>null</code> or blank. | |
27 | * @param includes the Ant-like pattern of the paths to index. Can be <code>null</code> or blank. | |
28 | * @return The Map of index Resource objects | |
29 | */ | |
30 | Map<String, Resource> indexResources(String rootURI, String rootPath, String syntax, String includes); | |
31 | ||
32 | } |