| 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 contained in the given index entity | |
| 23 | * | |
| 24 | * @param rootURI the root URI | |
| 25 | * @param entity the entity containg the index | |
| 26 | * @return The Map of index Resource objects | |
| 27 | */ | |
| 28 | Map<String, Resource> indexResources(String rootURI, String entity); | |
| 29 | ||
| 30 | } |