org.myire.munge

Class TransformTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.myire.munge.TransformTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class TransformTask
extends org.gradle.api.DefaultTask

Gradle task that performs file transformations specified in one or more TransformationSet instances.

Nested Class Summary

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

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

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

Constructor Summary

Constructors

Constructor and Description
TransformTask()

Method Summary

Modifier and Type	Method and Description
void	freeMarker(groovy.lang.Closure<?> pClosure) Add a FreeMarkerTransformationSet to the task.
java.lang.String	getFreeMarkerVersion() Get the version of the FreeMarker library to use.
java.lang.String	getJaxenVersion() Get the version of the Jaxen library to use.
java.lang.String	getSaxonVersion() Get the version of the Saxon library to use.
java.util.List<TransformationSet>	getTransformationSets() Get the transformation sets added to this task.
java.lang.String	getXalanVersion() Get the version of the Xalan library to use.
boolean	isFailOnError() Get the fail on error property.
void	saxon(groovy.lang.Closure<?> pClosure) Add a SaxonTransformationSet to the task.
void	setFailOnError(boolean pFailOnError)
void	setFreeMarkerVersion(java.lang.String pFreeMarkerVersion)
void	setJaxenVersion(java.lang.String pJaxenVersion)
void	setSaxonVersion(java.lang.String pSaxonVersion)
void	setXalanVersion(java.lang.String pXalanVersion)
void	transform() Execute the transformations specified in all transformation sets added to the task.

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

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString, usesService

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformTask

public TransformTask()

Method Detail

getTransformationSets

public java.util.List<TransformationSet> getTransformationSets()

Get the transformation sets added to this task.

Returns:

The list of transformation sets, never null.

saxon

public void saxon(groovy.lang.Closure<?> pClosure)

Add a SaxonTransformationSet to the task.

Parameters:

pClosure - A closure that configures the transformation set.

freeMarker

public void freeMarker(groovy.lang.Closure<?> pClosure)

Add a FreeMarkerTransformationSet to the task.

Parameters:

pClosure - A closure that configures the transformation set.

isFailOnError

@Input
public boolean isFailOnError()

Get the fail on error property. If this property is true, the transform() method will throw a GradleException if any transformation set reports a transformation error. If this property is false, errors will only be logged. The default value is false.

Returns:

The fail on error property.

setFailOnError

public void setFailOnError(boolean pFailOnError)

getSaxonVersion

@Input
 @Optional
public java.lang.String getSaxonVersion()

Get the version of the Saxon library to use. The default value is "9.9.1-8".

Returns:

The version of the Saxon library to use. Null means to disable the Saxon library.

setSaxonVersion

public void setSaxonVersion(java.lang.String pSaxonVersion)

getFreeMarkerVersion

@Input
 @Optional
public java.lang.String getFreeMarkerVersion()

Get the version of the FreeMarker library to use. The default value is "2.3.31".

Returns:

The version of the FreeMarker library to use. Null means to disable the FreeMarker library.

setFreeMarkerVersion

public void setFreeMarkerVersion(java.lang.String pFreeMarkerVersion)

getXalanVersion

@Input
 @Optional
public java.lang.String getXalanVersion()

Get the version of the Xalan library to use. The default value is null.

Returns:

The version of the Xalan library to use. Null means to disable the Xalan library.

setXalanVersion

public void setXalanVersion(java.lang.String pXalanVersion)

getJaxenVersion

@Input
 @Optional
public java.lang.String getJaxenVersion()

Get the version of the Jaxen library to use. The default value is "1.2.0".

Returns:

The version of the Jaxen library to use. Null means to disable the Jaxen library.

setJaxenVersion

public void setJaxenVersion(java.lang.String pJaxenVersion)

transform

public void transform()

Execute the transformations specified in all transformation sets added to the task. The transformations will be executed sequentially in the order they were added.

Throws:

org.gradle.api.GradleException - if at least one of the transformation sets reported an error and isFailOnError() is true.