@Incubating public class RoutesCompile extends SourceTask
This task is usually created as one of the build tasks when building a Play application with the PlayPlugin plugin.
Explicit configuration of this task is not expected and should be performed on the equivalent settings at the PlayApplicationSpec level.
Task.NamersourceTASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor and Description |
|---|
RoutesCompile() |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
getAdditionalImports()
Returns the additional imports of the Play Routes compiler.
|
BaseForkOptions |
getForkOptions()
The fork options to be applied to the Routes compiler.
|
boolean |
getInjectedRoutesGenerator()
Is the injected routes generator (
play.routes.compiler.InjectedRoutesGenerator) used for
generating routes? Default is false. |
File |
getOutputDirectory()
Returns the directory to generate the parser source files into.
|
PlayToolChain |
getToolChain()
Returns the tool chain that will be used to compile the routes source.
|
boolean |
isGenerateReverseRoutes()
Whether a reverse router should be generated.
|
boolean |
isJavaProject() |
boolean |
isNamespaceReverseRouter()
Whether the reverse router should be namespaced.
|
void |
setAdditionalImports(List<String> additionalImports)
Specifies the additional imports of the Play Routes compiler.
|
void |
setGenerateReverseRoutes(boolean generateReverseRoutes)
Sets whether or not a reverse router should be generated.
|
void |
setInjectedRoutesGenerator(boolean injectedRoutesGenerator)
Configure if the injected routes generator should be used to generate routes.
|
void |
setNamespaceReverseRouter(boolean namespaceReverseRouter)
Sets whether or not the reverse router should be namespaced.
|
void |
setOutputDirectory(File outputDirectory)
Specifies the directory to generate the parser source files into.
|
void |
setPlatform(PlayPlatform platform) |
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, getSource, include, include, include, include, setExcludes, setIncludes, setSource, sourceconventionMapping, conventionMapping, getConventionMappingaddValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, 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, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString@OutputDirectory public File getOutputDirectory()
public void setOutputDirectory(File outputDirectory)
outputDirectory - The output directory. Must not be null.@Input public List<String> getAdditionalImports()
public void setAdditionalImports(List<String> additionalImports)
public boolean isJavaProject()
public void setPlatform(PlayPlatform platform)
@Inject public PlayToolChain getToolChain()
public BaseForkOptions getForkOptions()
@Input public boolean isNamespaceReverseRouter()
public void setNamespaceReverseRouter(boolean namespaceReverseRouter)
@Input public boolean isGenerateReverseRoutes()
public void setGenerateReverseRoutes(boolean generateReverseRoutes)
@Input public boolean getInjectedRoutesGenerator()
play.routes.compiler.InjectedRoutesGenerator) used for
generating routes? Default is false.public void setInjectedRoutesGenerator(boolean injectedRoutesGenerator)
injectedRoutesGenerator - false - use StaticRoutesGenerator
true - use InjectedRoutesGenerator