03-UpdatePlugins

This commit is contained in:
Adrian-Devries 2025-04-24 12:53:53 +02:00
parent 6a06fb7c68
commit 04a236ec83
100 changed files with 193 additions and 193 deletions

View file

@ -94,9 +94,9 @@
<version.slf4j-simple>1.7.36</version.slf4j-simple> <version.slf4j-simple>1.7.36</version.slf4j-simple>
<!-- Plugins --> <!-- Plugins -->
<version.build-helper-maven-plugin>3.6.0</version.build-helper-maven-plugin> <version.build-helper-maven-plugin>3.6.0</version.build-helper-maven-plugin>
<version.dependency-check-maven>7.2.0</version.dependency-check-maven> <version.dependency-check-maven>12.1.1</version.dependency-check-maven>
<version.exec-maven-plugin>3.5.0</version.exec-maven-plugin> <version.exec-maven-plugin>3.5.0</version.exec-maven-plugin>
<version.formatter-maven-plugin>2.13.0</version.formatter-maven-plugin> <version.formatter-maven-plugin>2.26.0</version.formatter-maven-plugin>
<version.jacoco-maven-plugin>0.8.13</version.jacoco-maven-plugin> <version.jacoco-maven-plugin>0.8.13</version.jacoco-maven-plugin>
<version.jaxb2-basics>0.13.1</version.jaxb2-basics> <version.jaxb2-basics>0.13.1</version.jaxb2-basics>
<version.maven-antrun-plugin>3.1.0</version.maven-antrun-plugin> <version.maven-antrun-plugin>3.1.0</version.maven-antrun-plugin>

View file

@ -52,8 +52,8 @@ public interface Check {
/** /**
* Checks an incoming xml files in batch mode. Processing is sequential. The result-{@link Document Documents} are * Checks an incoming xml files in batch mode. Processing is sequential. The result-{@link Document Documents} are
* readonly. To change the this document you need to copy them into new {@link Document Documents}. * readonly. To change the this document you need to copy them into new {@link Document Documents}.
* *
* *
* @param input list of xml {@link Input Inputs} * @param input list of xml {@link Input Inputs}
* @return list of result-{@link Document Documents} (readonly) * @return list of result-{@link Document Documents} (readonly)
*/ */

View file

@ -31,7 +31,7 @@ import de.kosit.validationtool.impl.xml.ProcessorProvider;
/** /**
* Zentrale Konfigration einer Prüf-Instanz. * Zentrale Konfigration einer Prüf-Instanz.
* *
* @author Andreas Penski * @author Andreas Penski
* @deprecated since 1.3.0 use {@link Configuration} instead. Will be removed in 2.0 * @deprecated since 1.3.0 use {@link Configuration} instead. Will be removed in 2.0
*/ */

View file

@ -30,28 +30,28 @@ public interface Input {
/** /**
* The name of the input for document identification * The name of the input for document identification
* *
* @return the name * @return the name
*/ */
String getName(); String getName();
/** /**
* The hashcode for document identification * The hashcode for document identification
* *
* @return the computed hashcode * @return the computed hashcode
*/ */
byte[] getHashCode(); byte[] getHashCode();
/** /**
* The digest algorithm used for computing the {@link #getHashCode()} * The digest algorithm used for computing the {@link #getHashCode()}
* *
* @return the name of the digest algorith * @return the name of the digest algorith
*/ */
String getDigestAlgorithm(); String getDigestAlgorithm();
/** /**
* Creates a new {@link Source } for this input which carries the actual data * Creates a new {@link Source } for this input which carries the actual data
* *
* @return an open {@link Source} * @return an open {@link Source}
* @throws IOException on I/O while opening the source * @throws IOException on I/O while opening the source
*/ */

View file

@ -47,7 +47,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Service zum Einlesen des Test-Objekts in den Speicher. Beim Einlesen wird gleichzeitig eine Prüfsumme ermittelt und * Service zum Einlesen des Test-Objekts in den Speicher. Beim Einlesen wird gleichzeitig eine Prüfsumme ermittelt und
* mit dem Ergebnis mitgeführt. * mit dem Ergebnis mitgeführt.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -151,7 +151,7 @@ public class InputFactory {
/** /**
* Liest einen Prüfling von der übergebenen URL. Es wird ein definierter Algorithmus zur Ermittlung der Prüfsumme * Liest einen Prüfling von der übergebenen URL. Es wird ein definierter Algorithmus zur Ermittlung der Prüfsumme
* genutzt. * genutzt.
* *
* @param url URL des Prüflings * @param url URL des Prüflings
* @param digestAlgorithm der Prüfsummenalgorithmus * @param digestAlgorithm der Prüfsummenalgorithmus
* @return ein Prüf-Eingabe-Objekt * @return ein Prüf-Eingabe-Objekt
@ -173,7 +173,7 @@ public class InputFactory {
* Reads a test document from a {@link Source}. Note: computing the hashcode is only supported for * Reads a test document from a {@link Source}. Note: computing the hashcode is only supported for
* {@link StreamSource}. You can not directly use other {@link Source Soures}. You need to supply the hashcode for * {@link StreamSource}. You can not directly use other {@link Source Soures}. You need to supply the hashcode for
* identification then. * identification then.
* *
* @param source source * @param source source
* @return an {@link Input} * @return an {@link Input}
*/ */
@ -187,7 +187,7 @@ public class InputFactory {
/** /**
* Reads a test document from a {@link Source} using a specified digest algorithm. * Reads a test document from a {@link Source} using a specified digest algorithm.
* *
* Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other * Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other
* {@link Source Soures}. You need to supply the hashcode for identification then. * {@link Source Soures}. You need to supply the hashcode for identification then.
* *
@ -279,7 +279,7 @@ public class InputFactory {
/** /**
* Liest einen Prüfling vom übergebenen {@link InputStream}. * Liest einen Prüfling vom übergebenen {@link InputStream}.
* *
* @param inputStream der {@link InputStream} * @param inputStream der {@link InputStream}
* @param name der Name/Bezeichner des Prüflings * @param name der Name/Bezeichner des Prüflings
* @return einen Prüfling in eingelesener Form * @return einen Prüfling in eingelesener Form
@ -304,7 +304,7 @@ public class InputFactory {
/** /**
* Reads a saxon {@link XdmNode} with a given name. Hashcode identification is based on the name of the supplied * Reads a saxon {@link XdmNode} with a given name. Hashcode identification is based on the name of the supplied
* input. Now real hashcode is computed. * input. Now real hashcode is computed.
* *
* @param node the node to read * @param node the node to read
* @param name the name of the {@link Input} * @param name the name of the {@link Input}
* @return an {@link Input} to validate * @return an {@link Input} to validate

View file

@ -28,14 +28,14 @@ import net.sf.saxon.lib.UnparsedTextURIResolver;
/** /**
* Centralized construction and configuration of XML related infrastructure components. This interface allows to use * Centralized construction and configuration of XML related infrastructure components. This interface allows to use
* custom implementations and configurations of internal xml related factories and objects. * custom implementations and configurations of internal xml related factories and objects.
* *
* The KoSIT Validator provides out of the box implementations with various security levels based on openjdk SAX stack. * The KoSIT Validator provides out of the box implementations with various security levels based on openjdk SAX stack.
* *
* If you decide to implement a custom strategy, please be aware of XML security within your stack. The validator * If you decide to implement a custom strategy, please be aware of XML security within your stack. The validator
* components beyond this strategy asume secured implementation of the interfaces provided by this strategy. There is no * components beyond this strategy asume secured implementation of the interfaces provided by this strategy. There is no
* effort to mitigate or prevent xml related security issues such as XXE, loading external sources etc. Your would be * effort to mitigate or prevent xml related security issues such as XXE, loading external sources etc. Your would be
* responsible for this! * responsible for this!
* *
* @see de.kosit.validationtool.impl.ResolvingMode * @see de.kosit.validationtool.impl.ResolvingMode
* @author Andreas Penski * @author Andreas Penski
*/ */
@ -66,7 +66,7 @@ public interface ResolvingConfigurationStrategy {
/** /**
* Creates a specific implementation for resolving objects referenced via XSLT's <code>unparsed-text()</code> * Creates a specific implementation for resolving objects referenced via XSLT's <code>unparsed-text()</code>
* function. * function.
* *
* @param scenarioRepository an optional repository, your implementation might not need this * @param scenarioRepository an optional repository, your implementation might not need this
* @return a preconfigured {@link net.sf.saxon.lib.UnparsedTextURIResolver} or null for using saxons default * @return a preconfigured {@link net.sf.saxon.lib.UnparsedTextURIResolver} or null for using saxons default
*/ */
@ -75,7 +75,7 @@ public interface ResolvingConfigurationStrategy {
/** /**
* Creates a preconfigured {@link Validator } instance for a given schema for xml file validation. The * Creates a preconfigured {@link Validator } instance for a given schema for xml file validation. The
* implementation takes care about security and reference resolving strategies. * implementation takes care about security and reference resolving strategies.
* *
* @param schema the scheme to create a {@link Validator} for * @param schema the scheme to create a {@link Validator} for
* @return a preconfigured {@link Validator} * @return a preconfigured {@link Validator}
*/ */

View file

@ -18,21 +18,21 @@ package de.kosit.validationtool.api;
/** /**
* Fehlerobjekt für die Bereitstellung von Fehlern aus der internen Verarbeitung, bspw. Schema-Validation-Fehler. * Fehlerobjekt für die Bereitstellung von Fehlern aus der internen Verarbeitung, bspw. Schema-Validation-Fehler.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public interface XmlError { public interface XmlError {
/** /**
* Gibt die Fehlermeldung zurück. * Gibt die Fehlermeldung zurück.
* *
* @return die Fehlermeldung * @return die Fehlermeldung
*/ */
String getMessage(); String getMessage();
/** /**
* Zeigt den Schweregrad der Fehlermeldung an * Zeigt den Schweregrad der Fehlermeldung an
* *
* @return der Schweregrad * @return der Schweregrad
* @see Severity * @see Severity
*/ */
@ -40,14 +40,14 @@ public interface XmlError {
/** /**
* Gibt optional eine Zeilennummer an, aus der der Fehler resultiert. * Gibt optional eine Zeilennummer an, aus der der Fehler resultiert.
* *
* @return die Zeitelnnummer * @return die Zeitelnnummer
*/ */
Integer getRowNumber(); Integer getRowNumber();
/** /**
* Gibt optional eine Spaltennummer an, aus der der Fehler resultiert. * Gibt optional eine Spaltennummer an, aus der der Fehler resultiert.
* *
* @return die Spaltennummer * @return die Spaltennummer
*/ */
Integer getColumnNumber(); Integer getColumnNumber();

View file

@ -42,7 +42,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Überprüft den Report mittels bereitgestellter Assertions. Diese {@link CheckAction} dient der Überprüfung der von der * Überprüft den Report mittels bereitgestellter Assertions. Diese {@link CheckAction} dient der Überprüfung der von der
* KoSIT bereitgestellten Prüfszenarien und den darin enthaltenen Artefakten. * KoSIT bereitgestellten Prüfszenarien und den darin enthaltenen Artefakten.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -32,7 +32,7 @@ import picocli.CommandLine.ParseResult;
/** /**
* Commandline interface of the validator. It parses the commandline args and hands over actual execution to * Commandline interface of the validator. It parses the commandline args and hands over actual execution to
* {@link Validator}. * {@link Validator}.
* *
* This separated from {@link Validator} to configure the slf4j simple logging. * This separated from {@link Validator} to configure the slf4j simple logging.
* *
* @author Andreas Penski * @author Andreas Penski

View file

@ -34,7 +34,7 @@ import picocli.CommandLine.Parameters;
/** /**
* Commandline Interface definition. * Commandline Interface definition.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Command(description = "Structural and semantic validation of xml files", name = "KoSIT Validator", mixinStandardHelpOptions = false, @Command(description = "Structural and semantic validation of xml files", name = "KoSIT Validator", mixinStandardHelpOptions = false,
@ -111,7 +111,7 @@ public class CommandLineOptions implements Callable<ReturnValue> {
/** /**
* Definition of logical name and a path for a configuration artifact. * Definition of logical name and a path for a configuration artifact.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter
@ -125,7 +125,7 @@ public class CommandLineOptions implements Callable<ReturnValue> {
/** /**
* Definition of logical name and a path for a repository. * Definition of logical name and a path for a repository.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public static class RepositoryDefinition extends Definition { public static class RepositoryDefinition extends Definition {
@ -134,7 +134,7 @@ public class CommandLineOptions implements Callable<ReturnValue> {
/** /**
* Definition of logical name and a path for a scenario configuration file. * Definition of logical name and a path for a scenario configuration file.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public static class ScenarioDefinition extends Definition { public static class ScenarioDefinition extends Definition {

View file

@ -27,7 +27,7 @@ import lombok.Setter;
/** /**
* A default {@link NamingStrategy} supporting prefix and postfix configurations for generating report names * A default {@link NamingStrategy} supporting prefix and postfix configurations for generating report names
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Setter @Setter

View file

@ -33,7 +33,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Extrahiert HTML-Dokumente aus dem Report und persistiert diese im konfigurierten Ausgabe-Verzeichnis. * Extrahiert HTML-Dokumente aus dem Report und persistiert diese im konfigurierten Ausgabe-Verzeichnis.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -42,7 +42,7 @@ import net.sf.saxon.s9api.Processor;
/** /**
* Simple Erweiterung der Klasse {@link DefaultCheck} um das Ergebnis der Assertion-Prüfung auszuwerten und auszugeben. * Simple Erweiterung der Klasse {@link DefaultCheck} um das Ergebnis der Assertion-Prüfung auszuwerten und auszugeben.
* Diese Klasse stellt keine fachliche Erweiterung des eigentlichen Prüfvorganges dar! * Diese Klasse stellt keine fachliche Erweiterung des eigentlichen Prüfvorganges dar!
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -18,14 +18,14 @@ package de.kosit.validationtool.cmd;
/** /**
* Strategy for creating names. This is used for generating the report result name. * Strategy for creating names. This is used for generating the report result name.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public interface NamingStrategy { public interface NamingStrategy {
/** /**
* Create a name based on a base name * Create a name based on a base name
* *
* @param base the base name * @param base the base name
* @return the generated name * @return the generated name
*/ */

View file

@ -23,7 +23,7 @@ import lombok.extern.slf4j.Slf4j;
/** /**
* *
* Prints some memory usage information for debugging purposes. * Prints some memory usage information for debugging purposes.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -30,7 +30,7 @@ import net.sf.saxon.s9api.Serializer;
/** /**
* Gibt das Ergebnis-Document auf std-out aus. * Gibt das Ergebnis-Document auf std-out aus.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -22,7 +22,7 @@ import lombok.RequiredArgsConstructor;
/** /**
* CLI return codes. Codes > 0 indicate a processing error. Codes < indicates a configuration error. Code 0 indicates a * CLI return codes. Codes > 0 indicate a processing error. Codes < indicates a configuration error. Code 0 indicates a
* successful processing. * successful processing.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -29,7 +29,7 @@ import net.sf.saxon.s9api.Serializer;
/** /**
* Schreibt das Prüfergebnis als XML-Dokument an eine definierte Stelle. * Schreibt das Prüfergebnis als XML-Dokument an eine definierte Stelle.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -32,7 +32,7 @@ import picocli.CommandLine.ITypeConverter;
/** /**
* Custom type converters for dealing with command line input. * Custom type converters for dealing with command line input.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
class TypeConverter { class TypeConverter {

View file

@ -60,7 +60,7 @@ import net.sf.saxon.s9api.Processor;
/** /**
* Actual evaluation and processing of CommandLineOptions argumtens. * Actual evaluation and processing of CommandLineOptions argumtens.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -32,7 +32,7 @@ import lombok.Getter;
/** /**
* Simple value holder for ansi formatting codes. * Simple value holder for ansi formatting codes.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter

View file

@ -33,7 +33,7 @@ import lombok.RequiredArgsConstructor;
/** /**
* An text based grid for cli based programs. * An text based grid for cli based programs.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class Grid { public class Grid {

View file

@ -20,7 +20,7 @@ import org.apache.commons.lang3.StringUtils;
/** /**
* Justification modes for the text in grid columns. * Justification modes for the text in grid columns.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public enum Justify { public enum Justify {

View file

@ -25,7 +25,7 @@ import lombok.Getter;
/** /**
* Ansi formatted text for outputting to the console. * Ansi formatted text for outputting to the console.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter

View file

@ -21,14 +21,14 @@ import de.kosit.validationtool.impl.model.Result;
/** /**
* Internal interface for creating object builders. * Internal interface for creating object builders.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
interface Builder<T> { interface Builder<T> {
/** /**
* Creates an object based on artifacts provided via a defined {@link ContentRepository}. * Creates an object based on artifacts provided via a defined {@link ContentRepository}.
* *
* @param repository the {@link ContentRepository} * @param repository the {@link ContentRepository}
* @return the result of building the object * @return the result of building the object
*/ */

View file

@ -53,7 +53,7 @@ import net.sf.saxon.s9api.Processor;
/** /**
* Implements a builder style creation of a {@link Configuration}. * Implements a builder style creation of a {@link Configuration}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -82,7 +82,7 @@ public class ConfigurationBuilder {
/** /**
* Add a specific author name to this configuration. * Add a specific author name to this configuration.
* *
* @param authorName the name of the author * @param authorName the name of the author
* @return this * @return this
*/ */
@ -93,7 +93,7 @@ public class ConfigurationBuilder {
/** /**
* Add a specific nam to this configuration * Add a specific nam to this configuration
* *
* @param name the name of the configuration * @param name the name of the configuration
* @return this * @return this
*/ */
@ -104,7 +104,7 @@ public class ConfigurationBuilder {
/** /**
* Sets the date for this configuration. * Sets the date for this configuration.
* *
* @param date the date * @param date the date
* @return this * @return this
*/ */
@ -117,7 +117,7 @@ public class ConfigurationBuilder {
/** /**
* Sets the date for this configuration. * Sets the date for this configuration.
* *
* @param date the date * @param date the date
* @return this * @return this
*/ */
@ -128,7 +128,7 @@ public class ConfigurationBuilder {
/** /**
* Adds a {@link Scenario} to this list of know scenarios. Note: order of calling this methods defines order of * Adds a {@link Scenario} to this list of know scenarios. Note: order of calling this methods defines order of
* scenarios when determining the target scenario for a given xml file. * scenarios when determining the target scenario for a given xml file.
* *
* @param scenarioBuilder the {@link ScenarioBuilder} building the {@link Scenario} * @param scenarioBuilder the {@link ScenarioBuilder} building the {@link Scenario}
* @return this * @return this
*/ */
@ -140,7 +140,7 @@ public class ConfigurationBuilder {
/** /**
* Sets a specific fallback scenario configuration. Note: calling this more than once is possible, but the last call * Sets a specific fallback scenario configuration. Note: calling this more than once is possible, but the last call
* will define the actual fallback scenario used. There can be only one * will define the actual fallback scenario used. There can be only one
* *
* @param builder the {@link FallbackBuilder} * @param builder the {@link FallbackBuilder}
* @return this * @return this
*/ */
@ -154,7 +154,7 @@ public class ConfigurationBuilder {
/** /**
* Adds a description to this configuration. * Adds a description to this configuration.
* *
* @param description the descriptioin * @param description the descriptioin
* @return this * @return this
*/ */
@ -184,7 +184,7 @@ public class ConfigurationBuilder {
/** /**
* Create a named schematron configuration. * Create a named schematron configuration.
* *
* @param name the name of the schematron configuration * @param name the name of the schematron configuration
* @return new {@link SchemaBuilder} * @return new {@link SchemaBuilder}
*/ */
@ -234,7 +234,7 @@ public class ConfigurationBuilder {
/** /**
* Create a new named scenario configuration. * Create a new named scenario configuration.
* *
* @param name the name of the scenario * @param name the name of the scenario
* @return the scenario configuration builder * @return the scenario configuration builder
*/ */
@ -253,7 +253,7 @@ public class ConfigurationBuilder {
/** /**
* Create named report configuration. * Create named report configuration.
* *
* @param name the name of the report * @param name the name of the report
* @return the report configuration builder * @return the report configuration builder
*/ */
@ -263,7 +263,7 @@ public class ConfigurationBuilder {
/** /**
* Builds the actual {@link Configuration} by validating all builder inputs and constructing neccessary objects. * Builds the actual {@link Configuration} by validating all builder inputs and constructing neccessary objects.
* *
* @return a valid configuration * @return a valid configuration
* @throws IllegalStateException when the configuration is not valid/complete * @throws IllegalStateException when the configuration is not valid/complete
*/ */
@ -339,7 +339,7 @@ public class ConfigurationBuilder {
/** /**
* Sets a specific resolving mode, for resolving xml artifacts for this configuration. See {@link ResolvingMode} for * Sets a specific resolving mode, for resolving xml artifacts for this configuration. See {@link ResolvingMode} for
* details. * details.
* *
* @param mode the mode * @param mode the mode
* @return this * @return this
*/ */
@ -350,7 +350,7 @@ public class ConfigurationBuilder {
/** /**
* Sets a specific strategy to use for resolving artefacts for scenarios. * Sets a specific strategy to use for resolving artefacts for scenarios.
* *
* @param strategy the strategy * @param strategy the strategy
* @return this * @return this
*/ */
@ -361,7 +361,7 @@ public class ConfigurationBuilder {
/** /**
* Set a specific repository location for resolving artifacts for scenarios. * Set a specific repository location for resolving artifacts for scenarios.
* *
* @param repository the repository location * @param repository the repository location
* @return this * @return this
*/ */

View file

@ -58,7 +58,7 @@ import net.sf.saxon.s9api.XdmNodeKind;
/** /**
* Configuration class that loads necessary {@link Check} configuration from an existing scenario.xml specification. * Configuration class that loads necessary {@link Check} configuration from an existing scenario.xml specification.
* This is the recommended option when an official configuration exists as is the case with 'xrechnung'. * This is the recommended option when an official configuration exists as is the case with 'xrechnung'.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor
@ -201,7 +201,7 @@ public class ConfigurationLoader {
/** /**
* Sets actual {@link ResolvingMode}, when the validator needs to resolve stuff on startup. * Sets actual {@link ResolvingMode}, when the validator needs to resolve stuff on startup.
* *
* @param mode the resolving mode * @param mode the resolving mode
* @return this * @return this
*/ */
@ -220,7 +220,7 @@ public class ConfigurationLoader {
/** /**
* Add a parameter to the configuration. * Add a parameter to the configuration.
* *
* @param name the name of the parameter * @param name the name of the parameter
* @param value the parameter value object * @param value the parameter value object
* @return this * @return this

View file

@ -31,7 +31,7 @@ import de.kosit.validationtool.impl.Scenario;
/** /**
* Default implementation class for {@link Configuration}. This class contains all information to run a * Default implementation class for {@link Configuration}. This class contains all information to run a
* {@link de.kosit.validationtool.impl.DefaultCheck}. * {@link de.kosit.validationtool.impl.DefaultCheck}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -30,7 +30,7 @@ import de.kosit.validationtool.model.scenarios.ScenarioType;
/** /**
* Create a fallback {@link Scenario} configuration. * Create a fallback {@link Scenario} configuration.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class FallbackBuilder implements Builder<Scenario> { public class FallbackBuilder implements Builder<Scenario> {

View file

@ -18,7 +18,7 @@ package de.kosit.validationtool.config;
/** /**
* Defines some keys used for supplying additional parameters internally. * Defines some keys used for supplying additional parameters internally.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public final class Keys { public final class Keys {

View file

@ -37,7 +37,7 @@ import net.sf.saxon.s9api.XsltExecutable;
/** /**
* Builder style configuration for the report transformation. * Builder style configuration for the report transformation.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -50,7 +50,7 @@ import net.sf.saxon.s9api.XPathExecutable;
/** /**
* Builder for {@link Scenario} configuration. * Builder for {@link Scenario} configuration.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor
@ -96,7 +96,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add a preconfiguration {@link XPathExecutable} to match the scenario * Add a preconfiguration {@link XPathExecutable} to match the scenario
* *
* @param executable the xpath executable * @param executable the xpath executable
* @return this * @return this
*/ */
@ -107,7 +107,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add an xpath expression to match the scenario. You can leverage declared namespaces. * Add an xpath expression to match the scenario. You can leverage declared namespaces.
* *
* @param xpath the expression * @param xpath the expression
* @return this * @return this
*/ */
@ -118,7 +118,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Declare a namespace to use for match and accept configurations. * Declare a namespace to use for match and accept configurations.
* *
* @param prefix the prefix to use * @param prefix the prefix to use
* @param uri the uri of this namespace * @param uri the uri of this namespace
* @return this * @return this
@ -130,7 +130,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add a preconfiguration {@link XPathExecutable} to compute acceptance for the scenario * Add a preconfiguration {@link XPathExecutable} to compute acceptance for the scenario
* *
* @param executable the xpath executable * @param executable the xpath executable
* @return this * @return this
*/ */
@ -141,7 +141,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add an xpath expression to compute acceptance for the scenario. You can leverage declared namespaces. * Add an xpath expression to compute acceptance for the scenario. You can leverage declared namespaces.
* *
* @param acceptXpath the xpath expresison * @param acceptXpath the xpath expresison
* @return this * @return this
*/ */
@ -152,7 +152,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add a schematron validation configuration for this scenario. * Add a schematron validation configuration for this scenario.
* *
* @param schematron the schematron configuration * @param schematron the schematron configuration
* @return this * @return this
*/ */
@ -165,7 +165,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Validate matching {@link de.kosit.validationtool.api.Input Inputs} with the specified schema configuration. * Validate matching {@link de.kosit.validationtool.api.Input Inputs} with the specified schema configuration.
* *
* @param schema the schema configuration * @param schema the schema configuration
* @return this * @return this
*/ */
@ -178,7 +178,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
* Add description for this scenario. This is part of the * Add description for this scenario. This is part of the
* {@link de.kosit.validationtool.model.reportInput.CreateReportInput} configuration and can be used while creating * {@link de.kosit.validationtool.model.reportInput.CreateReportInput} configuration and can be used while creating
* the report * the report
* *
* @param description the description * @param description the description
* @return this * @return this
*/ */
@ -189,7 +189,7 @@ public class ScenarioBuilder implements Builder<Scenario> {
/** /**
* Add a configuration for generating the final report for the {@link de.kosit.validationtool.api.Input}. * Add a configuration for generating the final report for the {@link de.kosit.validationtool.api.Input}.
* *
* @param reportBuilder the report configuration * @param reportBuilder the report configuration
* @return this * @return this
*/ */

View file

@ -36,7 +36,7 @@ import de.kosit.validationtool.model.scenarios.ValidateWithXmlSchema;
/** /**
* Builder for Schema validation configuration. * Builder for Schema validation configuration.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -84,7 +84,7 @@ public class SchemaBuilder implements Builder<Pair<ValidateWithXmlSchema, Schema
/** /**
* Set a specific precompiled schema to check. * Set a specific precompiled schema to check.
* *
* @param schema the {@link Schema} * @param schema the {@link Schema}
* @return this * @return this
*/ */
@ -95,7 +95,7 @@ public class SchemaBuilder implements Builder<Pair<ValidateWithXmlSchema, Schema
/** /**
* Set a specific schema location either to compile or to document the precompiled one . * Set a specific schema location either to compile or to document the precompiled one .
* *
* @param schemaLocation the schema location as uri * @param schemaLocation the schema location as uri
* @return this * @return this
*/ */
@ -126,7 +126,7 @@ public class SchemaBuilder implements Builder<Pair<ValidateWithXmlSchema, Schema
/** /**
* Set a specific name to identify this schema. * Set a specific name to identify this schema.
* *
* @param name the name of the schema * @param name the name of the schema
* @return this * @return this
*/ */

View file

@ -37,7 +37,7 @@ import net.sf.saxon.s9api.XsltExecutable;
/** /**
* Builder for schematron validation configuration. * Builder for schematron validation configuration.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -88,7 +88,7 @@ public class SchematronBuilder implements Builder<Pair<ValidateWithSchematron, T
/** /**
* Specifices a source for this schematron validation. This is either used to compile the schematron transformation * Specifices a source for this schematron validation. This is either used to compile the schematron transformation
* or as documentation for a precompiled tranformation. * or as documentation for a precompiled tranformation.
* *
* @param source the source * @param source the source
* @return this * @return this
*/ */
@ -99,7 +99,7 @@ public class SchematronBuilder implements Builder<Pair<ValidateWithSchematron, T
/** /**
* Specifices a source for this schematron validation. This is either used to compile the schematron transformation * Specifices a source for this schematron validation. This is either used to compile the schematron transformation
* or as documentation for a precompiled tranformation. * or as documentation for a precompiled tranformation.
* *
* @param source the source * @param source the source
* @return this * @return this
*/ */
@ -111,7 +111,7 @@ public class SchematronBuilder implements Builder<Pair<ValidateWithSchematron, T
/** /**
* Specifices a source for this schematron validation. This is either used to compile the schematron transformation * Specifices a source for this schematron validation. This is either used to compile the schematron transformation
* or as documentation for a precompiled tranformation. * or as documentation for a precompiled tranformation.
* *
* @param source the source * @param source the source
* @return this * @return this
*/ */
@ -121,7 +121,7 @@ public class SchematronBuilder implements Builder<Pair<ValidateWithSchematron, T
/** /**
* Sets the name of the schematron source to a specific value. * Sets the name of the schematron source to a specific value.
* *
* @param name the name * @param name the name
* @return this * @return this
*/ */

View file

@ -40,7 +40,7 @@ import net.sf.saxon.s9api.XPathExecutable;
/** /**
* Internal class to represent xpath configuration. * Internal class to represent xpath configuration.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -24,7 +24,7 @@ import com.sun.net.httpserver.HttpHandler;
/** /**
* Simple base implemenation for http handlers. Doing I/O stuff. * Simple base implemenation for http handlers. Doing I/O stuff.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
abstract class BaseHandler implements HttpHandler { abstract class BaseHandler implements HttpHandler {

View file

@ -38,7 +38,7 @@ import de.kosit.validationtool.model.scenarios.Scenarios;
/** /**
* Handler that returns the actual configuration used for this daemon instance. * Handler that returns the actual configuration used for this daemon instance.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -62,7 +62,7 @@ public class Daemon {
/** /**
* Create a new daemon. * Create a new daemon.
* *
* @param hostname the interface to bind to * @param hostname the interface to bind to
* @param port the port to expose * @param port the port to expose
* @param threadCount the number of working threads * @param threadCount the number of working threads
@ -75,7 +75,7 @@ public class Daemon {
/** /**
* Methode zum Starten des Servers * Methode zum Starten des Servers
* *
* @param config the configuration to use * @param config the configuration to use
*/ */
public void startServer(final Processor processor, final Configuration... config) { public void startServer(final Processor processor, final Configuration... config) {

View file

@ -33,7 +33,7 @@ import de.kosit.validationtool.model.daemon.MemoryType;
/** /**
* Handler that implements a simple health check. Useful for monitoring the service. * Handler that implements a simple health check. Useful for monitoring the service.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -18,7 +18,7 @@ package de.kosit.validationtool.daemon;
/** /**
* Status codes for the HTTP daemon. * Status codes for the HTTP daemon.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public interface HttpStatus { public interface HttpStatus {

View file

@ -100,7 +100,7 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
/** /**
* Zeigt an, ob Validierungsfehler vorhanden sind. * Zeigt an, ob Validierungsfehler vorhanden sind.
* *
* @return true wenn mindestens ein Fehler vorhanden ist. * @return true wenn mindestens ein Fehler vorhanden ist.
*/ */
public boolean hasErrors() { public boolean hasErrors() {
@ -109,7 +109,7 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
/** /**
* Zeigt an, ob es Validierungs-Ereignisse gab. * Zeigt an, ob es Validierungs-Ereignisse gab.
* *
* @return true wenn mindestens ein Validierungsereignis aufgetreten ist * @return true wenn mindestens ein Validierungsereignis aufgetreten ist
*/ */
public boolean hasEvents() { public boolean hasEvents() {

View file

@ -60,7 +60,7 @@ import net.sf.saxon.s9api.XsltExecutable;
/** /**
* Repository für verschiedene XML Artefakte zur Vearbeitung der Prüfszenarien. * Repository für verschiedene XML Artefakte zur Vearbeitung der Prüfszenarien.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor
@ -84,7 +84,7 @@ public class ContentRepository {
/** /**
* Creates a new {@link ContentRepository} based on configured security and resolving strategy and the specified * Creates a new {@link ContentRepository} based on configured security and resolving strategy and the specified
* repository location. * repository location.
* *
* @param strategy the security and resolving strategy * @param strategy the security and resolving strategy
* @param repository the repository. * @param repository the repository.
*/ */
@ -160,7 +160,7 @@ public class ContentRepository {
/** /**
* Erzeugt ein Schema auf Basis der übegebenen URIs * Erzeugt ein Schema auf Basis der übegebenen URIs
* *
* @param uris die uris in String-Repräsentation * @param uris die uris in String-Repräsentation
* @return das Schema * @return das Schema
*/ */
@ -200,7 +200,7 @@ public class ContentRepository {
/** /**
* Erzeugt einen [@link XPathExecutable} auf Basis der angegebenen Informationen. * Erzeugt einen [@link XPathExecutable} auf Basis der angegebenen Informationen.
* *
* @param expression der XPATH-Ausdruck * @param expression der XPATH-Ausdruck
* @param namespaces optionale Namespace-Mappings * @param namespaces optionale Namespace-Mappings
* @return ein kompiliertes Executable * @return ein kompiliertes Executable
@ -220,7 +220,7 @@ public class ContentRepository {
/** /**
* Returns the {@link URIResolver} to use for resolving xml artifacts. * Returns the {@link URIResolver} to use for resolving xml artifacts.
* *
* @return the resolver * @return the resolver
*/ */
public URIResolver getResolver() { public URIResolver getResolver() {

View file

@ -39,7 +39,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Das Default-{@link Result} für die Rückgabe in der API * Das Default-{@link Result} für die Rückgabe in der API
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class DefaultResult implements Result { public class DefaultResult implements Result {
@ -113,7 +113,7 @@ public class DefaultResult implements Result {
/** /**
* Extrahiert evtl. im Report vorhandene HTML-Fragmente als String. * Extrahiert evtl. im Report vorhandene HTML-Fragmente als String.
* *
* @return Liste mit HTML Strings. * @return Liste mit HTML Strings.
*/ */
public List<String> extractHtmlAsString() { public List<String> extractHtmlAsString() {
@ -140,7 +140,7 @@ public class DefaultResult implements Result {
/** /**
* Gibt alle Schematron-Ergebnisse vom Typ {@link FailedAssert} zurück. * Gibt alle Schematron-Ergebnisse vom Typ {@link FailedAssert} zurück.
* *
* @return die {@link FailedAssert} * @return die {@link FailedAssert}
*/ */
@Override @Override

View file

@ -22,7 +22,7 @@ import java.util.Properties;
/** /**
* Hält statische Informatione über diesen Validator. * Hält statische Informatione über diesen Validator.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class EngineInformation { public class EngineInformation {
@ -46,7 +46,7 @@ public class EngineInformation {
/** /**
* Gibt die Versions-Nummer des Validators zurück. * Gibt die Versions-Nummer des Validators zurück.
* *
* @return die Version * @return die Version
*/ */
public static String getVersion() { public static String getVersion() {
@ -55,7 +55,7 @@ public class EngineInformation {
/** /**
* Gibt den Namen der Engine zurück. * Gibt den Namen der Engine zurück.
* *
* @return der Name * @return der Name
*/ */
public static String getName() { public static String getName() {
@ -74,7 +74,7 @@ public class EngineInformation {
/** /**
* Gibt die Major-Versions-Nummer des eingesetzten Frameworks zurück. * Gibt die Major-Versions-Nummer des eingesetzten Frameworks zurück.
* *
* @return die Major-Versions-Nummer * @return die Major-Versions-Nummer
*/ */
public static String getFrameworkMajorVersion() { public static String getFrameworkMajorVersion() {
@ -87,7 +87,7 @@ public class EngineInformation {
/** /**
* Gibt den Namespace des eingesetzten Frameworks zurück. * Gibt den Namespace des eingesetzten Frameworks zurück.
* *
* @return die Major-Versions-Nummer * @return die Major-Versions-Nummer
*/ */
public static String getFrameworkNamespace() { public static String getFrameworkNamespace() {

View file

@ -99,7 +99,7 @@ public class HtmlExtractor {
/** /**
* Extrahiert evtl. vorhandene HTML-Knoten als String. * Extrahiert evtl. vorhandene HTML-Knoten als String.
* *
* @param node der root knoten * @param node der root knoten
* @return HTML-Fragment als String * @return HTML-Fragment als String
*/ */

View file

@ -21,7 +21,7 @@ import java.util.Locale;
/** /**
* Wrapper for {@link System Systems} printing capability. * Wrapper for {@link System Systems} printing capability.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@SuppressWarnings("squid:S106") @SuppressWarnings("squid:S106")
@ -33,7 +33,7 @@ public class Printer {
/** /**
* Writes to standard output channel. * Writes to standard output channel.
* *
* @param message the message with placeholders * @param message the message with placeholders
* @param params the params. * @param params the params.
*/ */
@ -53,7 +53,7 @@ public class Printer {
/** /**
* Writes to standard error channel and prints a stacktrace. * Writes to standard error channel and prints a stacktrace.
* *
* @param ex the exception * @param ex the exception
* @param message the message with placeholders * @param message the message with placeholders
* @param params the params * @param params the params

View file

@ -26,7 +26,7 @@ import de.kosit.validationtool.impl.xml.StrictRelativeResolvingStrategy;
/** /**
* Defines how artefacts are resolved internally. * Defines how artefacts are resolved internally.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -32,7 +32,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Repository for die aktiven Szenario einer Prüfinstanz. * Repository for die aktiven Szenario einer Prüfinstanz.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -29,7 +29,7 @@ import de.kosit.validationtool.api.Input;
/** /**
* Base class for all {@link Input Inputs}. * Base class for all {@link Input Inputs}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -28,7 +28,7 @@ import lombok.Getter;
/** /**
* Classical in-memory {@link de.kosit.validationtool.api.Input}. It is not memory efficient to read the whole file into * Classical in-memory {@link de.kosit.validationtool.api.Input}. It is not memory efficient to read the whole file into
* memory prio validating. Consider using the {@link ResourceInput}. * memory prio validating. Consider using the {@link ResourceInput}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter

View file

@ -22,7 +22,7 @@ import de.kosit.validationtool.api.Input;
/** /**
* Internal interface used for lazy generation of the hashcode for document identification. * Internal interface used for lazy generation of the hashcode for document identification.
* *
* @see StreamHelper#wrapDigesting(LazyReadInput, InputStream, String) for details * @see StreamHelper#wrapDigesting(LazyReadInput, InputStream, String) for details
* @author Andreas Penski * @author Andreas Penski
*/ */
@ -30,21 +30,21 @@ interface LazyReadInput {
/** /**
* Sets a hashcode * Sets a hashcode
* *
* @param digest the digest * @param digest the digest
*/ */
void setHashCode(byte[] digest); void setHashCode(byte[] digest);
/** /**
* Determines whether a hashcode has been computed yet * Determines whether a hashcode has been computed yet
* *
* @return true when computed * @return true when computed
*/ */
boolean isHashcodeComputed(); boolean isHashcodeComputed();
/** /**
* Setting the length of the {@link Input}. * Setting the length of the {@link Input}.
* *
* @param length the length * @param length the length
*/ */
void setLength(long length); void setLength(long length);

View file

@ -32,10 +32,10 @@ import de.kosit.validationtool.api.Input;
/** /**
* An {@link Input} carries an {@link URL} which can be used for all 'locatable' inputs such as {@link File}, * An {@link Input} carries an {@link URL} which can be used for all 'locatable' inputs such as {@link File},
* {@link java.nio.file.Path} and any other {@link URL}. * {@link java.nio.file.Path} and any other {@link URL}.
* *
* This stream is NOT read into memory. So this implementation has good in memory efficieny. The validation process MAY * This stream is NOT read into memory. So this implementation has good in memory efficieny. The validation process MAY
* read the stream more than once. Make sure, that the {@link URL} points to fast I/O devices * read the stream more than once. Make sure, that the {@link URL} points to fast I/O devices
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter

View file

@ -38,7 +38,7 @@ import net.sf.saxon.om.TreeInfo;
* <p> * <p>
* Note: The various implementations of {@link Source} varies wether the can be read twice or no. This implementation * Note: The various implementations of {@link Source} varies wether the can be read twice or no. This implementation
* tries to handle this with respect document identification (hashcode). * tries to handle this with respect document identification (hashcode).
* *
* This class is known to work with: * This class is known to work with:
* <ul> * <ul>
* <li>{@link StreamSource} - both {@link java.io.InputStream} based and {@link java.io.Reader} based</li> * <li>{@link StreamSource} - both {@link java.io.InputStream} based and {@link java.io.Reader} based</li>
@ -46,9 +46,9 @@ import net.sf.saxon.om.TreeInfo;
* <li>{@link javax.xml.bind.util.JAXBSource}</li> * <li>{@link javax.xml.bind.util.JAXBSource}</li>
* <li>{@link TreeInfo}</li> * <li>{@link TreeInfo}</li>
* </ul> * </ul>
* *
* Other {@link Source Sources} may work as well, please try and let us know. * Other {@link Source Sources} may work as well, please try and let us know.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Getter @Getter

View file

@ -32,7 +32,7 @@ import de.kosit.validationtool.api.Input;
/** /**
* Helper for stream handling. * Helper for stream handling.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class StreamHelper { public class StreamHelper {
@ -129,7 +129,7 @@ public class StreamHelper {
/** /**
* Wraps the {@link InputStream} with a counting length implementation. * Wraps the {@link InputStream} with a counting length implementation.
* *
* @param input the {@link LazyReadInput input} * @param input the {@link LazyReadInput input}
* @param stream the stream * @param stream the stream
* @return a wrapped stream * @return a wrapped stream
@ -155,7 +155,7 @@ public class StreamHelper {
/** /**
* Drains the {@link Input} without further processing. This is useful to computing hashcode etc. * Drains the {@link Input} without further processing. This is useful to computing hashcode etc.
* *
* @param input the input * @param input the input
* @return the input drained once * @return the input drained once
* @throws IOException on I/O errors * @throws IOException on I/O errors

View file

@ -27,7 +27,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* An {@link Input} implementation holding saxon's {@link XdmNode} object. * An {@link Input} implementation holding saxon's {@link XdmNode} object.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -28,7 +28,7 @@ import org.oclc.purl.dsdl.svrl.FiredRule;
/** /**
* Basis-Klasse um spezifische Erweiterungen an der generierten Klasse {@link org.oclc.purl.dsdl.svrl.SchematronOutput} * Basis-Klasse um spezifische Erweiterungen an der generierten Klasse {@link org.oclc.purl.dsdl.svrl.SchematronOutput}
* umzusetzen. * umzusetzen.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public abstract class BaseOutput { public abstract class BaseOutput {
@ -37,7 +37,7 @@ public abstract class BaseOutput {
/** /**
* Gibt die Liste der {@link FailedAssert} zurück * Gibt die Liste der {@link FailedAssert} zurück
* *
* @return Liste mit {@link FailedAssert} * @return Liste mit {@link FailedAssert}
*/ */
public List<FailedAssert> getFailedAsserts() { public List<FailedAssert> getFailedAsserts() {
@ -46,7 +46,7 @@ public abstract class BaseOutput {
/** /**
* Gibt die Liste der {@link FailedAssert} zurück * Gibt die Liste der {@link FailedAssert} zurück
* *
* @return Liste mit {@link FailedAssert} * @return Liste mit {@link FailedAssert}
*/ */
public List<FiredRule> getFiredRules() { public List<FiredRule> getFiredRules() {
@ -55,7 +55,7 @@ public abstract class BaseOutput {
/** /**
* Ermittelt, ob es bei der Validierung {@link FailedAssert}s gab. * Ermittelt, ob es bei der Validierung {@link FailedAssert}s gab.
* *
* @return true wenn mindestens ein {@link FailedAssert} vorhanden ist * @return true wenn mindestens ein {@link FailedAssert} vorhanden ist
*/ */
public boolean hasFailedAsserts() { public boolean hasFailedAsserts() {
@ -77,7 +77,7 @@ public abstract class BaseOutput {
/** /**
* Sucht nach einem {@link FailedAssert} mit einem definierten Namen. * Sucht nach einem {@link FailedAssert} mit einem definierten Namen.
* *
* @param name der Name * @param name der Name
* @return Optional mit dem {@link FailedAssert} * @return Optional mit dem {@link FailedAssert}
*/ */

View file

@ -24,14 +24,14 @@ import de.kosit.validationtool.model.reportInput.XMLSyntaxErrorSeverity;
/** /**
* Basis-Klasse für Syntax-Error. Wird über die JAXB-generierte Klasse * Basis-Klasse für Syntax-Error. Wird über die JAXB-generierte Klasse
* {@link de.kosit.validationtool.model.reportInput.XMLSyntaxError} erweitert. * {@link de.kosit.validationtool.model.reportInput.XMLSyntaxError} erweitert.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public abstract class BaseXMLSyntaxError implements XmlError { public abstract class BaseXMLSyntaxError implements XmlError {
/** /**
* Logged den Syntax-Fehler über einen definierten Logger. * Logged den Syntax-Fehler über einen definierten Logger.
* *
* @param logger der Logger * @param logger der Logger
*/ */
public void log(final Logger logger) { public void log(final Logger logger) {
@ -59,7 +59,7 @@ public abstract class BaseXMLSyntaxError implements XmlError {
/** /**
* Dies ist der API-Zugriff. Es gibt zwei Methoden, weil es für die API einen abweichenden Typ gibt. * Dies ist der API-Zugriff. Es gibt zwei Methoden, weil es für die API einen abweichenden Typ gibt.
* *
* @return der Schweregrad * @return der Schweregrad
*/ */
@Override @Override

View file

@ -26,7 +26,7 @@ import lombok.NoArgsConstructor;
/** /**
* Ein Ergebnisobjekt, dass das eigentliche Ergebnis hält und optional auch verschiedene Fehlerobjekte. * Ein Ergebnisobjekt, dass das eigentliche Ergebnis hält und optional auch verschiedene Fehlerobjekte.
* *
* @param <T> der Typ des Ergebnis-Objekts * @param <T> der Typ des Ergebnis-Objekts
* @param <E> der Typ des Fehler-Objekts * @param <E> der Typ des Fehler-Objekts
*/ */
@ -41,7 +41,7 @@ public class Result<T, E> {
/** /**
* Erzeugt ein neues Ergebnis mit Fehler * Erzeugt ein neues Ergebnis mit Fehler
* *
* @param errors die Fehler * @param errors die Fehler
*/ */
public Result(Collection<E> errors) { public Result(Collection<E> errors) {
@ -50,7 +50,7 @@ public class Result<T, E> {
/** /**
* Erzeugt ein neues Ergebnis mit einem Ergebnisobjekt * Erzeugt ein neues Ergebnis mit einem Ergebnisobjekt
* *
* @param o * @param o
*/ */
public Result(T o) { public Result(T o) {
@ -59,7 +59,7 @@ public class Result<T, E> {
/** /**
* Zeigt an, ob das Ergebnis valide, also ohne Fehler ist. * Zeigt an, ob das Ergebnis valide, also ohne Fehler ist.
* *
* @return true wenn erfolgreich * @return true wenn erfolgreich
*/ */
public boolean isValid() { public boolean isValid() {
@ -68,7 +68,7 @@ public class Result<T, E> {
/** /**
* Zeigt an, ob das Ergebnis nicht valide ist, als entsprechend Fehler gesammelt wurden. * Zeigt an, ob das Ergebnis nicht valide ist, als entsprechend Fehler gesammelt wurden.
* *
* @return true wenn erfolgreich wenn Fehler vorhanden sind. * @return true wenn erfolgreich wenn Fehler vorhanden sind.
*/ */
public boolean isInvalid() { public boolean isInvalid() {

View file

@ -39,7 +39,7 @@ import net.sf.saxon.s9api.XdmNode;
* Interface, welches von allen Prüfschritten implementiert wird. Der Parameter vom Typ {@link Bag} dient dabei sowohl * Interface, welches von allen Prüfschritten implementiert wird. Der Parameter vom Typ {@link Bag} dient dabei sowohl
* als Quellce für Eingabe Parameter als auch für die Aufnahme von Ergebnisse, die an weitere Schritte weitergeleitet * als Quellce für Eingabe Parameter als auch für die Aufnahme von Ergebnisse, die an weitere Schritte weitergeleitet
* werden sollen. * werden sollen.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@FunctionalInterface @FunctionalInterface

View file

@ -31,7 +31,7 @@ import net.sf.saxon.s9api.XPathSelector;
/** /**
* Computes a {@link AcceptRecommendation} for this instance. This is either based on an 'acceptMatch'-configuration of * Computes a {@link AcceptRecommendation} for this instance. This is either based on an 'acceptMatch'-configuration of
* the active scenario or based on overall evaluation about schema and semantic (schematron) correctness of the * the active scenario or based on overall evaluation about schema and semantic (schematron) correctness of the
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -20,7 +20,7 @@ import de.kosit.validationtool.model.reportInput.DocumentIdentificationType;
/** /**
* Creates a document identification element for the report by using the generates hash. * Creates a document identification element for the report by using the generates hash.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class CreateDocumentIdentificationAction implements CheckAction { public class CreateDocumentIdentificationAction implements CheckAction {

View file

@ -57,7 +57,7 @@ import net.sf.saxon.sapling.Saplings;
/** /**
* Erzeugt den Report auf Basis der gesammelten Informationen über den Prüfling. Sollte kein Szenario identifiziert * Erzeugt den Report auf Basis der gesammelten Informationen über den Prüfling. Sollte kein Szenario identifiziert
* worden sein, so wird ein das Fallback-Szenario verwend und ein default report} erzeugt. * worden sein, so wird ein das Fallback-Szenario verwend und ein default report} erzeugt.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -37,7 +37,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Setzt Parsing-Funktionalitäten um. Prüft auf well-formedness * Setzt Parsing-Funktionalitäten um. Prüft auf well-formedness
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -50,7 +50,7 @@ public class DocumentParseAction implements CheckAction {
* Parsed und überprüft ein übergebenes Dokument darauf ob es well-formed ist. Dies stellt den ersten * Parsed und überprüft ein übergebenes Dokument darauf ob es well-formed ist. Dies stellt den ersten
* Verarbeitungsschritt des Prüf-Tools dar. Diese Funktion verzichtet explizit auf die Validierung gegenüber einem * Verarbeitungsschritt des Prüf-Tools dar. Diese Funktion verzichtet explizit auf die Validierung gegenüber einem
* Schema. * Schema.
* *
* @param content ein Dokument * @param content ein Dokument
* @return Ergebnis des Parsings inklusive etwaiger Fehler * @return Ergebnis des Parsings inklusive etwaiger Fehler
*/ */

View file

@ -29,7 +29,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Identifiziert das der Eingabe entsprechende Szenario, sofern eines konfiguriert ist. Setzt das Fallback-Szenario, * Identifiziert das der Eingabe entsprechende Szenario, sofern eines konfiguriert ist. Setzt das Fallback-Szenario,
* wenn keines identifiziert werden konnte. * wenn keines identifiziert werden konnte.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -61,7 +61,7 @@ import net.sf.saxon.s9api.XdmNode;
* This implementation tries to do the validation in an efficient manner. If possible the source is read a second time * This implementation tries to do the validation in an efficient manner. If possible the source is read a second time
* to validate. If not, the source is serialized to the heap upon re-read/validaiton up to a configurable file size. The * to validate. If not, the source is serialized to the heap upon re-read/validaiton up to a configurable file size. The
* document is serialized to a temporary file otherwise. * document is serialized to a temporary file otherwise.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -42,7 +42,7 @@ import net.sf.saxon.s9api.XsltTransformer;
/** /**
* Ausführung von konfigurierten Schematron Validierungen eines Szenarios. * Ausführung von konfigurierten Schematron Validierungen eines Szenarios.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -30,7 +30,7 @@ import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
/** /**
* Validiert die gesammelten Informationen über den Prüfling. Zusätzlich Check. * Validiert die gesammelten Informationen über den Prüfling. Zusätzlich Check.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@RequiredArgsConstructor @RequiredArgsConstructor

View file

@ -33,7 +33,7 @@ import lombok.extern.slf4j.Slf4j;
/** /**
* {@link LSResourceResolver} der objekte relativ zu einem Basis-Pfad aus dem Classpath der Anwendung laden kann. * {@link LSResourceResolver} der objekte relativ zu einem Basis-Pfad aus dem Classpath der Anwendung laden kann.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -65,7 +65,7 @@ public class ClassPathResourceResolver implements LSResourceResolver {
/** /**
* Instantiierung einer neue Instanz. * Instantiierung einer neue Instanz.
* *
* @param publicId die publicId * @param publicId die publicId
* @param systemId die systemId * @param systemId die systemId
* @param baseURI die baseURI * @param baseURI die baseURI

View file

@ -29,7 +29,7 @@ import lombok.extern.slf4j.Slf4j;
* This is a slightly more open implementation that allows resolving artifacts from local filesystems. Your are not * This is a slightly more open implementation that allows resolving artifacts from local filesystems. Your are not
* bound to a specific 'repository'. But your validation artifacts (schema, xsl, etc.) must be available locally. This * bound to a specific 'repository'. But your validation artifacts (schema, xsl, etc.) must be available locally. This
* implementation does not allow loading from http sources * implementation does not allow loading from http sources
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j
@ -37,7 +37,7 @@ public class StrictLocalResolvingStrategy extends StrictRelativeResolvingStrateg
/** /**
* Allow loading schema files from any local location. * Allow loading schema files from any local location.
* *
* @return a configured {@link SchemaFactory} * @return a configured {@link SchemaFactory}
*/ */
@Override @Override
@ -49,7 +49,7 @@ public class StrictLocalResolvingStrategy extends StrictRelativeResolvingStrateg
/** /**
* The default resolver is able to resolve locally and relative. * The default resolver is able to resolve locally and relative.
* *
* @param repository the repository is not used by this strategy * @param repository the repository is not used by this strategy
* @return null! * @return null!
*/ */

View file

@ -24,7 +24,7 @@ import de.kosit.validationtool.impl.Helper.Simple;
/** /**
* Test {@link CheckConfiguration }. * Test {@link CheckConfiguration }.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Deprecated @Deprecated

View file

@ -54,7 +54,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Testet den Hashcode-Service. * Testet den Hashcode-Service.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class InputFactoryTest { public class InputFactoryTest {

View file

@ -34,7 +34,7 @@ import de.kosit.validationtool.model.reportInput.CreateReportInput;
/** /**
* Testet das Assertion-Feature. * Testet das Assertion-Feature.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class CheckAssertionActionTest { public class CheckAssertionActionTest {

View file

@ -34,7 +34,7 @@ import lombok.Setter;
/** /**
* Helferlein um Ausgaben auf der Kommandozeile zu testen. * Helferlein um Ausgaben auf der Kommandozeile zu testen.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class CommandLine { public class CommandLine {

View file

@ -38,7 +38,7 @@ import de.kosit.validationtool.impl.Helper.Simple;
/** /**
* Testet die Parameter des Kommandozeilen-Tools. * Testet die Parameter des Kommandozeilen-Tools.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -22,7 +22,7 @@ import org.junit.Test;
/** /**
* Tests {@link DefaultNamingStrategy} * Tests {@link DefaultNamingStrategy}
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class DefaultNamingStrategyTest { public class DefaultNamingStrategyTest {

View file

@ -36,7 +36,7 @@ import de.kosit.validationtool.impl.tasks.CheckAction;
/** /**
* Testet die HTML-Extrkation des Kommondazeilenprogramms. * Testet die HTML-Extrkation des Kommondazeilenprogramms.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ExtractHtmlActionTest { public class ExtractHtmlActionTest {

View file

@ -34,7 +34,7 @@ import de.kosit.validationtool.impl.Helper;
/** /**
* Test {@link ConfigurationBuilder}. * Test {@link ConfigurationBuilder}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ConfigurationBuilderTest { public class ConfigurationBuilderTest {

View file

@ -39,7 +39,7 @@ import net.sf.saxon.s9api.XPathExecutable;
/** /**
* Test {@link ScenarioBuilder}. * Test {@link ScenarioBuilder}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ScenarioBuilderTest { public class ScenarioBuilderTest {

View file

@ -34,7 +34,7 @@ import de.kosit.validationtool.model.scenarios.ValidateWithXmlSchema;
/** /**
* Tests {@link SchemaBuilder}. * Tests {@link SchemaBuilder}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class SchemaBuilderTest { public class SchemaBuilderTest {

View file

@ -33,7 +33,7 @@ import net.sf.saxon.s9api.XPathExecutable;
/** /**
* Tests {@link XPathBuilder}. * Tests {@link XPathBuilder}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class XPathBuilderTest { public class XPathBuilderTest {

View file

@ -22,7 +22,7 @@ import io.restassured.RestAssured;
/** /**
* Base for integration tests. * Base for integration tests.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public abstract class BaseIT { public abstract class BaseIT {

View file

@ -24,7 +24,7 @@ import io.restassured.http.ContentType;
/** /**
* Integration test for the {@link ConfigHandler}. * Integration test for the {@link ConfigHandler}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ConfigHandlerIT extends BaseIT { public class ConfigHandlerIT extends BaseIT {

View file

@ -24,7 +24,7 @@ import io.restassured.http.ContentType;
/** /**
* Checks the health endpoint. * Checks the health endpoint.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class HealthHandlerIT extends BaseIT { public class HealthHandlerIT extends BaseIT {

View file

@ -39,7 +39,7 @@ import net.sf.saxon.s9api.XsltExecutable;
/** /**
* Testet das repository. * Testet das repository.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ContentRepositoryTest { public class ContentRepositoryTest {

View file

@ -33,7 +33,7 @@ import de.kosit.validationtool.model.scenarios.Scenarios;
/** /**
* Simple test for testing the jaxb conversion service. * Simple test for testing the jaxb conversion service.
* *
* @author apenski * @author apenski
*/ */
public class ConversionServiceTest { public class ConversionServiceTest {

View file

@ -49,7 +49,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Test das Check-Interface * Test das Check-Interface
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class DefaultCheckTest { public class DefaultCheckTest {

View file

@ -40,7 +40,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Helferlein für Test-Artefakte * Helferlein für Test-Artefakte
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@ -129,7 +129,7 @@ public class Helper {
/** /**
* Lädt ein XML-Dokument von der gegebenen URL * Lädt ein XML-Dokument von der gegebenen URL
* *
* @param url die url die geladen werden soll * @param url die url die geladen werden soll
* @return ein result objekt mit Dokument * @return ein result objekt mit Dokument
*/ */

View file

@ -34,7 +34,7 @@ import de.kosit.validationtool.impl.xml.RelativeUriResolver;
/** /**
* Testet den Uri-Resolver der relative auflösen soll * Testet den Uri-Resolver der relative auflösen soll
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class RelativeUriResolverTest { public class RelativeUriResolverTest {

View file

@ -39,7 +39,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Testet das {@link ScenarioRepository}. * Testet das {@link ScenarioRepository}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */

View file

@ -31,7 +31,7 @@ import de.kosit.validationtool.impl.Helper.Simple;
/** /**
* Prüft die Funktionen des Validator auf Basis eines reduzierten Szenarios. * Prüft die Funktionen des Validator auf Basis eines reduzierten Szenarios.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class SimpleScenarioCheckTest { public class SimpleScenarioCheckTest {

View file

@ -34,7 +34,7 @@ import net.sf.saxon.s9api.XPathExecutable;
/** /**
* Tests the 'acceptMatch' functionality. * Tests the 'acceptMatch' functionality.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class ComputeAcceptanceActionTest { public class ComputeAcceptanceActionTest {

View file

@ -42,7 +42,7 @@ import net.sf.saxon.s9api.SaxonApiException;
/** /**
* Test for {@link CreateReportAction}. * Test for {@link CreateReportAction}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class CreateReportActionTest { public class CreateReportActionTest {

View file

@ -51,7 +51,7 @@ import de.kosit.validationtool.impl.tasks.CheckAction.Bag;
/** /**
* Tests die {@link SchemaValidationAction}. * Tests die {@link SchemaValidationAction}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class SchemaValidatorActionTest { public class SchemaValidatorActionTest {

View file

@ -41,7 +41,7 @@ import net.sf.saxon.s9api.XsltTransformer;
/** /**
* Tests {@link SchematronValidationAction}. * Tests {@link SchematronValidationAction}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class SchematronValidationActionTest { public class SchematronValidationActionTest {

View file

@ -49,7 +49,7 @@ import net.sf.saxon.s9api.XdmNode;
/** /**
* Utilities for creating test objects. * Utilities for creating test objects.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class TestBagBuilder { public class TestBagBuilder {

View file

@ -34,9 +34,9 @@ import org.xml.sax.SAXNotSupportedException;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
/** /**
* *
* Tests the internal functions used to create a secure resolver * Tests the internal functions used to create a secure resolver
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class BaseResolverConfigurationTest { public class BaseResolverConfigurationTest {

View file

@ -30,7 +30,7 @@ import de.kosit.validationtool.impl.Helper.Resolving;
/** /**
* Tests {@link RemoteResolvingStrategy}. * Tests {@link RemoteResolvingStrategy}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class RemoteResolvingStrategyTest { public class RemoteResolvingStrategyTest {

View file

@ -48,7 +48,7 @@ import net.sf.saxon.s9api.XsltTransformer;
/** /**
* Testet verschiedene Saxon Security Einstellungen. * Testet verschiedene Saxon Security Einstellungen.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@Slf4j @Slf4j

View file

@ -32,7 +32,7 @@ import de.kosit.validationtool.impl.Helper.Resolving;
/** /**
* Tests {@link StrictLocalResolvingStrategy} * Tests {@link StrictLocalResolvingStrategy}
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class StrictLocalResolvingTest { public class StrictLocalResolvingTest {

View file

@ -32,7 +32,7 @@ import de.kosit.validationtool.impl.Helper.Resolving;
/** /**
* Tests {@link StrictRelativeResolvingStrategy}. * Tests {@link StrictRelativeResolvingStrategy}.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public class StrictRelativeResolvingTest { public class StrictRelativeResolvingTest {