Resolve "Force formatting"

This commit is contained in:
Andreas Penski 2020-09-03 06:02:42 +00:00
parent bc9acc3a0a
commit 69d6e55f14
45 changed files with 535 additions and 538 deletions

View file

@ -16,7 +16,7 @@ public enum AcceptRecommendation {
ACCEPTABLE,
/**
* Recommendation is to reject {@link Input} based on the evaluation of the overall validation.
* Recommendation is to reject {@link Input} based on the evaluation of the overall validation.
*/
REJECT
}

View file

@ -24,7 +24,6 @@ import java.util.stream.Collectors;
import org.w3c.dom.Document;
/**
* Main validator interface for checking incoming files.
*
@ -33,8 +32,8 @@ import org.w3c.dom.Document;
public interface Check {
/**
* Checks an incoming xml {@link Input Inputs}. The result-{@link Document} is readonly. To change the this document you
* need to copy the nodes into an new {@link Document}.
* Checks an incoming xml {@link Input Inputs}. The result-{@link Document} is readonly. To change the this document
* you need to copy the nodes into an new {@link Document}.
*
* @param input the resource / xml file to validate.
* @return a result-{@link Document} (readonly)
@ -75,5 +74,4 @@ public interface Check {
return input.stream().map(this::checkInput).collect(Collectors.toList());
}
}

View file

@ -54,8 +54,6 @@ public class CheckConfiguration implements Configuration {
*/
private URI scenarioRepository;
private Configuration delegate;
private Configuration getDelegate() {
@ -95,8 +93,6 @@ public class CheckConfiguration implements Configuration {
return getDelegate().getAuthor();
}
@Override
public ContentRepository getContentRepository() {
return getDelegate().getContentRepository();

View file

@ -62,8 +62,8 @@ public interface Configuration {
String getDate();
/**
* Add some additional parameters to the validator configuration. Parameter usage depends on actual implementation of
* {@link Check}
* Add some additional parameters to the validator configuration. Parameter usage depends on actual implementation
* of {@link Check}
*
* @return
*/

View file

@ -79,8 +79,8 @@ public class InputFactory {
}
/**
* Liest einen Prüfling von dem übergebenen Pfad. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der Prüfsumme
* genutzt.
* Liest einen Prüfling von dem übergebenen Pfad. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der
* Prüfsumme genutzt.
*
* @param path der Prüflings
* @return ein Prüf-Eingabe-Objekt
@ -114,8 +114,8 @@ public class InputFactory {
}
/**
* Liest einen Prüfling von der übergebenen URI. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der Prüfsumme
* genutzt.
* Liest einen Prüfling von der übergebenen URI. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der
* Prüfsumme genutzt.
*
* @param uri URI des Prüflings
* @return ein Prüf-Eingabe-Objekt
@ -141,8 +141,8 @@ public class InputFactory {
}
/**
* Liest einen Prüfling von der übergebenen URL. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der Prüfsumme
* genutzt.
* Liest einen Prüfling von der übergebenen URL. Es wird der Default-Prüfsummenalgorithmus zur Ermittlung der
* Prüfsumme genutzt.
*
* @param url URL des Prüflings
* @return ein Prüf-Eingabe-Objekt
@ -173,8 +173,9 @@ public class InputFactory {
}
/**
* 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 identification then.
* 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
* identification then.
*
* @param source source
* @return an {@link Input}
@ -190,8 +191,8 @@ public class InputFactory {
/**
* 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 {@link Source
* Soures}. You need to supply the hashcode for identification then.
* 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.
*
* @param source source
* @param name the digest algorithm
@ -304,8 +305,8 @@ public class InputFactory {
}
/**
* 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.
* 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.
*
* @param node the node to read
* @param name the name of the {@link Input}

View file

@ -36,8 +36,8 @@ public interface ResolvingConfigurationStrategy {
/**
* Returns a preconfigured {@link Processor Saxon Processor} for various tasks within the Validator. The validator
* leverages the saxon s9api for internal processing e.g. xml reading and writing. So this is the main object to secure
* for reading, transforming and writing xml files.
* leverages the saxon s9api for internal processing e.g. xml reading and writing. So this is the main object to
* secure for reading, transforming and writing xml files.
*
* Note: you need exactly one instance for all validator related processing.
*
@ -50,8 +50,8 @@ public interface ResolvingConfigurationStrategy {
* dereferencing an absolute URI (after resolution) to return a {@link javax.xml.transform.Source}. It <b>can</b> be
* used for resolving relative URIs against a base URI or restrict access to certain URIs.
* <p>
* This URIResolver is used to dereference the URIs appearing in <code>xsl:import</code>, <code>xsl:include</code>, and
* <code>xsl:import-schema</code> declarations.
* This URIResolver is used to dereference the URIs appearing in <code>xsl:import</code>, <code>xsl:include</code>,
* and <code>xsl:import-schema</code> declarations.
* </p>
*
* @param scenarioRepository an optional repository, your implementation might not need this
@ -60,7 +60,8 @@ public interface ResolvingConfigurationStrategy {
URIResolver createResolver(URI scenarioRepository);
/**
* Creates a specific implementation for resolving objects referenced via XSLT's <code>unparsed-text()</code> function.
* Creates a specific implementation for resolving objects referenced via XSLT's <code>unparsed-text()</code>
* function.
*
* @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
@ -68,8 +69,8 @@ public interface ResolvingConfigurationStrategy {
UnparsedTextURIResolver createUnparsedTextURIResolver(URI scenarioRepository);
/**
* Creates a preconfigured {@link Validator } instance for a given schema for xml file validation. The implementation
* takes care about security and reference resolving strategies.
* Creates a preconfigured {@link Validator } instance for a given schema for xml file validation. The
* implementation takes care about security and reference resolving strategies.
*
* @param schema the scheme to create a {@link Validator} for
* @return a preconfigured {@link Validator}

View file

@ -16,8 +16,8 @@ import net.sf.saxon.s9api.XdmNode;
public interface Result {
/**
* Zeigt an, ob die Verarbeitung durch den Validator erfolgreich durchlaufen wurde. Diese Funktion macht ausdrücklich
* keine Aussage über die zur Akzeptanz.
* Zeigt an, ob die Verarbeitung durch den Validator erfolgreich durchlaufen wurde. Diese Funktion macht
* ausdrücklich keine Aussage über die zur Akzeptanz.
*
* @return true, wenn die Verarbeitung komplett und erfolgreich durchlaufen wurde
* @see #getAcceptRecommendation()
@ -92,7 +92,8 @@ public interface Result {
boolean isWellformed();
/**
* Returns true, if schematron has been checked and the result does not contain any {@link FailedAssert FailedAsserts}.
* Returns true, if schematron has been checked and the result does not contain any {@link FailedAssert
* FailedAsserts}.
*
* @return true, if valid
*/