org.gradle.playframework.tasks

Class RoutesCompile

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.gradle.playframework.tasks.RoutesCompile

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>

public class RoutesCompile
extends org.gradle.api.tasks.SourceTask

Task for compiling routes templates into Scala code.

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_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
RoutesCompile(org.gradle.workers.WorkerExecutor workerExecutor)

Method Summary

Modifier and Type	Method and Description
org.gradle.api.provider.ListProperty<String>	getAdditionalImports() Returns the additional imports of the Play Routes compiler.
org.gradle.api.provider.Property<Boolean>	getGenerateReverseRoutes() Whether a reverse router should be generated.
org.gradle.api.provider.Property<Boolean>	getInjectedRoutesGenerator() Is the injected routes generator (play.routes.compiler.InjectedRoutesGenerator) used for generating routes? Default is false.
org.gradle.api.provider.Property<Boolean>	getNamespaceReverseRouter() Whether the reverse router should be namespaced.
org.gradle.api.file.DirectoryProperty	getOutputDirectory() Returns the directory to generate the parser source files into.
org.gradle.api.provider.Property<PlayPlatform>	getPlatform()
org.gradle.api.file.ConfigurableFileCollection	getRoutesCompilerClasspath()
org.gradle.api.file.FileTree	getSource()
boolean	isJavaProject()

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, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, 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, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

RoutesCompile

@Inject
public RoutesCompile(org.gradle.workers.WorkerExecutor workerExecutor)

Method Detail

getSource

@PathSensitive(value=RELATIVE)
public org.gradle.api.file.FileTree getSource()

Overrides:

getSource in class org.gradle.api.tasks.SourceTask

getOutputDirectory

@OutputDirectory
public org.gradle.api.file.DirectoryProperty getOutputDirectory()

Returns the directory to generate the parser source files into.

Returns:

The output directory.

getAdditionalImports

@Input
public org.gradle.api.provider.ListProperty<String> getAdditionalImports()

Returns the additional imports of the Play Routes compiler.

Returns:

The additional imports.

getRoutesCompilerClasspath

@Classpath
public org.gradle.api.file.ConfigurableFileCollection getRoutesCompilerClasspath()

isJavaProject

@Internal
public boolean isJavaProject()

getPlatform

@Internal
public org.gradle.api.provider.Property<PlayPlatform> getPlatform()

getNamespaceReverseRouter

@Input
public org.gradle.api.provider.Property<Boolean> getNamespaceReverseRouter()

Whether the reverse router should be namespaced.

Returns:

Whether the reverse router should be namespaced

getGenerateReverseRoutes

@Input
public org.gradle.api.provider.Property<Boolean> getGenerateReverseRoutes()

Whether a reverse router should be generated. Default is true.

Returns:

Whether a reverse router should be generated

getInjectedRoutesGenerator

@Input
public org.gradle.api.provider.Property<Boolean> getInjectedRoutesGenerator()

Is the injected routes generator (play.routes.compiler.InjectedRoutesGenerator) used for generating routes? Default is false.

Returns:

false if StaticRoutesGenerator will be used to generate routes, true if InjectedRoutesGenerator will be used to generate routes.