Package name.jurgenei.gradle.xml

Class SchematronTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
name.jurgenei.gradle.xml.AbstractXmlValidationTask
name.jurgenei.gradle.xml.SchematronTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, ValidationTaskSpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Schematron compilation and validation depends on external schema files") public abstract class SchematronTask extends AbstractXmlValidationTask
Validates XML files via Schematron by compiling .sch to XSLT and producing SVRL output.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    SchematronTask()
    Creates a Schematron validation task.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getSchema()
    Returns the Schematron rules file used for validation.
    abstract org.gradle.api.file.RegularFileProperty
    getTranspilerStylesheet()
    Returns an optional override for the bundled SchXslt transpiler stylesheet.
    void
    schema(Object path)
    Sets the Schematron schema file using Gradle file notation.
    void
    transpilerStylesheet(Object path)
    Sets a custom transpiler stylesheet.
    protected ValidationResult
    validate(File inputFile, Map<String,String> params)
    Validates a single input file and returns normalized findings.

    Methods inherited from class name.jurgenei.gradle.xml.AbstractXmlValidationTask

    fileset, getFailOnError, getJunitOutputDir, getJunitSuiteName, getMaxFailures, getOutputDir, getOutputExtension, getParams, getReportFormat, getSource, getWorkers, param, validateAll

    Methods inherited from class org.gradle.api.tasks.SourceTask

    exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

    Methods inherited from class org.gradle.api.internal.ConventionTask

    conventionMapping, conventionMapping, getConventionMapping

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • SchematronTask

      public SchematronTask()
      Creates a Schematron validation task.

  • Method Details

    • getSchema

      @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.file.RegularFileProperty getSchema()
      Returns the Schematron rules file used for validation.
      Returns:
      Schematron schema file used for validation

    • getTranspilerStylesheet

      @Optional @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.file.RegularFileProperty getTranspilerStylesheet()
      Returns an optional override for the bundled SchXslt transpiler stylesheet.
      Returns:
      optional transpiler stylesheet overriding bundled SchXslt transpiler

    • schema

      public void schema(Object path)
      Sets the Schematron schema file using Gradle file notation.
      Parameters:
      path - file notation accepted by Project.file

    • transpilerStylesheet

      public void transpilerStylesheet(Object path)
      Sets a custom transpiler stylesheet.
      Parameters:
      path - file notation accepted by Project.file

    • validate

      protected ValidationResult validate(File inputFile, Map<String,String> params) throws Exception
      Description copied from class: AbstractXmlValidationTask
      Validates a single input file and returns normalized findings.
      Specified by:
      validate in class AbstractXmlValidationTask
      Parameters:
      inputFile - file to validate
      params - task-level validation parameters
      Returns:
      normalized validation result
      Throws:
      Exception - when validation cannot be performed