Package org.gradle.play.tasks
Class TwirlCompile
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.play.tasks.TwirlCompile
- All Implemented Interfaces:
Comparable<Task>
,org.gradle.api.internal.DynamicObjectAware
,org.gradle.api.internal.IConventionAware
,org.gradle.api.internal.TaskInternal
,ExtensionAware
,Task
,PatternFilterable
,org.gradle.util.Configurable<Task>
Task for compiling Twirl templates into Scala code.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
Field Summary
Fields inherited from class org.gradle.api.tasks.SourceTask
source
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addUserTemplateFormat
(String extension, String templateType, String... imports) Adds a custom template format.Returns the list of additional imports to add to the generated Scala code.Returns the default imports that will be used when compiling templates.fork options for the twirl compiler.Returns the directory to generate the parser source files into.Returns the tool chain that will be used to compile the twirl source.Returns the custom template formats configured for this task.void
setAdditionalImports
(List<String> additionalImports) Sets the additional imports to add to all generated Scala code.void
setDefaultImports
(TwirlImports defaultImports) Sets the default imports to be used when compiling templates.void
setOutputDirectory
(File outputDirectory) Specifies the directory to generate the parser source files into.void
setPlatform
(PlayPlatform platform) void
setToolChain
(PlayToolChain toolChain) Sets the tool chain that will be used to compile the twirl source.void
setUserTemplateFormats
(List<TwirlTemplateFormat> userTemplateFormats) Sets the custom template formats for this task.Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, getSource, 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
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
Constructor Details
-
TwirlCompile
public TwirlCompile()
-
-
Method Details
-
getForkOptions
fork options for the twirl compiler. -
getOutputDirectory
Returns the directory to generate the parser source files into.- Returns:
- The output directory.
-
getDependencyNotation
-
setOutputDirectory
Specifies the directory to generate the parser source files into.- Parameters:
outputDirectory
- The output directory. Must not be null.
-
getDefaultImports
Returns the default imports that will be used when compiling templates.- Returns:
- The imports that will be used.
-
setDefaultImports
Sets the default imports to be used when compiling templates.- Parameters:
defaultImports
- The imports to be used.
-
setPlatform
-
getToolChain
Returns the tool chain that will be used to compile the twirl source.- Returns:
- The tool chain.
-
setToolChain
Sets the tool chain that will be used to compile the twirl source.- Parameters:
toolChain
- The tool chain.
-
getUserTemplateFormats
Returns the custom template formats configured for this task.- Since:
- 4.2
-
setUserTemplateFormats
Sets the custom template formats for this task.- Since:
- 4.2
-
addUserTemplateFormat
Adds a custom template format.- Parameters:
extension
- file extension this template applies to (e.g.,html
).templateType
- fully-qualified type for this template format.imports
- additional imports to add for the custom template format.- Since:
- 4.2
-
getAdditionalImports
Returns the list of additional imports to add to the generated Scala code.- Since:
- 4.2
-
setAdditionalImports
Sets the additional imports to add to all generated Scala code.- Parameters:
additionalImports
- additional imports- Since:
- 4.2
-