demo/validator
1
0
Fork 0
mirror of https://github.com/itplr-kosit/validator.git synced 2026-05-25 16:55:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated API code snippet in readme for GitHub #117

Browse source
This commit is contained in:
Philip Helger 2025-11-07 13:10:45 +01:00 • committed by Renzo Kottmann
parent 7f180881bb
commit e5acc2535b
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -74,12 +74,12 @@ The [CLI documentation](./docs/cli.md) shows further configuration options.
The Validator can also be used in own Java Applications via the API. An example use of the API as follows: The Validator can also be used in own Java Applications via the API. An example use of the API as follows:
```java ```java
Path scenarios = Paths.get("scenarios.xml"); URL scenarios = this.getClass().getClassLoader().getResource("scenarios.xml");
Configuration config = Configuration.load(scenarios.toUri()); Configuration config = Configuration.load(scenarios.toURI()).build(ProcessorProvider.getProcessor());
Input document = InputFactory.read(testDocument);
Check validator = new DefaultCheck(config); Check validator = new DefaultCheck(config);
Result validationResult = validator.checkInput(document);
Input document = InputFactory.read(testDocument);
Result report = validator.checkInput(document);
// examine the result here // examine the result here
``` ```
@ -139,8 +139,8 @@ To use the standalone version with Maven coordinates, add the respective classif
This section describes the next steps planned in the Validator development. This section describes the next steps planned in the Validator development.
* Release version 1.6.0 based on Java 11 and using Jakarta 4.x. - Autumn 2025 * Version 1.5.x is frozen - no maintainance, no support
* Drop support of version 1.5.x when version 1.6 is released * Version 1.6.x - no feature development, but maintainance and best-effort support
* Develop version 2.0.0 which will include major API incompatibilities - Winter 2025 * Develop version 2.0.0 which will include major API incompatibilities - Winter 2025
* Rework scenarios.xml * Rework scenarios.xml
* Rework report output engine * Rework report output engine