mirror of
https://github.com/itplr-kosit/validator.git
synced 2026-06-10 09:10:03 +00:00
some cleanup
This commit is contained in:
parent
1a001a1af4
commit
7dc62012a6
22 changed files with 144 additions and 50 deletions
|
|
@ -12,15 +12,15 @@ import de.kosit.validationtool.impl.Scenario;
|
|||
/**
|
||||
* Configuration of the actual {@link Check} instance. This is an interface and can be implemented by custom
|
||||
* configuration classes. There are two implementations supported out of the box:
|
||||
*
|
||||
*
|
||||
* <ol>
|
||||
* <li>{@link ConfigurationLoader} implements loading {@link Check} configurations from a scenario.xml file</li>
|
||||
* <li>Using a builder style api {@link de.kosit.validationtool.config.ConfigurationBuilder}to configure the
|
||||
* {@link Check}</li>
|
||||
* </ol>
|
||||
*
|
||||
* <p>
|
||||
* Both methods can be used via convinience methods. See below.
|
||||
*
|
||||
*
|
||||
* @author Andreas Penski
|
||||
*/
|
||||
|
||||
|
|
@ -28,51 +28,57 @@ public interface Configuration {
|
|||
|
||||
/**
|
||||
* Returns a list of configured scenarios.
|
||||
*
|
||||
*
|
||||
* @return the list of scenarios
|
||||
*/
|
||||
List<Scenario> getScenarios();
|
||||
|
||||
/**
|
||||
* Returns the configured fallback scenario to use, in case no configured scenario match.
|
||||
*
|
||||
*
|
||||
* @return the fallback scenario
|
||||
*/
|
||||
Scenario getFallbackScenario();
|
||||
|
||||
/**
|
||||
* Returns the author of this configuration.
|
||||
*
|
||||
*
|
||||
* @return the author
|
||||
*/
|
||||
String getAuthor();
|
||||
|
||||
/**
|
||||
* Returns the name of the specification
|
||||
*
|
||||
*
|
||||
* @return the name
|
||||
*/
|
||||
String getName();
|
||||
|
||||
/**
|
||||
* The creation date of the config
|
||||
*
|
||||
*
|
||||
* @return the date
|
||||
*/
|
||||
String getDate();
|
||||
|
||||
/**
|
||||
* Add some additional parameters to the validator configuration. Parameter usage depends on actual implementation of
|
||||
* {@link Check}
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
Map<String, Object> getAdditionalParameters();
|
||||
|
||||
/**
|
||||
* The content repository including resolving strategies.
|
||||
*
|
||||
*
|
||||
* @return the configured {@link ContentRepository}
|
||||
*/
|
||||
ContentRepository getContentRepository();
|
||||
|
||||
/**
|
||||
* Loads an XML based scenario definition from the file specified via URI.
|
||||
*
|
||||
*
|
||||
* @param scenarioDefinition the XML file with scenario definition
|
||||
* @return the loaded configuration
|
||||
*/
|
||||
|
|
@ -93,7 +99,7 @@ public interface Configuration {
|
|||
|
||||
/**
|
||||
* Creates a {@link Configuration} based on a builder style API using {@link ConfigurationBuilder}
|
||||
*
|
||||
*
|
||||
* @return the Builder
|
||||
*/
|
||||
static ConfigurationBuilder create() {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue