Package name.jurgenei.gradle.xml

Class XsltTask

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.AbstractXmlTransformTask
name.jurgenei.gradle.xml.XsltTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, 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="XSLT transformations depend on external stylesheet and input files") public abstract class XsltTask extends AbstractXmlTransformTask
Transforms XML input files using a Saxon XSLT stylesheet.

Task behavior (sources, output mapping, parameters, and concurrency) is inherited from AbstractXmlTransformTask.

  • 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
    XsltTask()
    Creates an XSLT transformation task.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getStylesheet()
    Stylesheet file used to compile the XSLT transformation.
    protected long
    latestDependencyTimestamp(File inputFile)
    Returns the newest timestamp of any file dependency that influences a transformation.
    void
    style(Object path)
    Sets the XSLT stylesheet in Gradle DSL friendly form.
    protected void
    transform(File inputFile, File outputFile, Map<String,String> params)
    Executes one transformation from input file to output file.

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

    fileset, getFailOnError, getOutputDir, getOutputExtension, getParams, getSource, getWorkers, param, transformAll

    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

    • XsltTask

      public XsltTask()
      Creates an XSLT transformation task.

  • Method Details

    • getStylesheet

      @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.file.RegularFileProperty getStylesheet()
      Stylesheet file used to compile the XSLT transformation.
      Returns:
      stylesheet file property

    • transform

      protected void transform(File inputFile, File outputFile, Map<String,String> params) throws net.sf.saxon.s9api.SaxonApiException
      Description copied from class: AbstractXmlTransformTask
      Executes one transformation from input file to output file.
      Specified by:
      transform in class AbstractXmlTransformTask
      Parameters:
      inputFile - source XML document
      outputFile - destination file
      params - immutable task parameter view
      Throws:
      net.sf.saxon.s9api.SaxonApiException

    • latestDependencyTimestamp

      protected long latestDependencyTimestamp(File inputFile)
      Description copied from class: AbstractXmlTransformTask
      Returns the newest timestamp of any file dependency that influences a transformation.

      By default this is the source file timestamp. Subclasses should override to include additional inputs such as stylesheets or query files.

      Overrides:
      latestDependencyTimestamp in class AbstractXmlTransformTask
      Parameters:
      inputFile - source XML document
      Returns:
      newest dependency timestamp in epoch milliseconds

    • style

      public void style(Object path)
      Sets the XSLT stylesheet in Gradle DSL friendly form.
      Parameters:
      path - file notation supported by Project.file