Class RoutesCompile

  • 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>

    @Incubating
    public class RoutesCompile
    extends SourceTask
    Task for compiling routes templates into Scala code.

    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.

    • Constructor Detail

      • RoutesCompile

        public RoutesCompile()
    • Method Detail

      • getSource

        @PathSensitive(RELATIVE)
        public FileTree getSource()
        Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

        The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.

        Overrides:
        getSource in class SourceTask
        Returns:
        The source.
      • getOutputDirectory

        @OutputDirectory
        public File getOutputDirectory()
        Returns the directory to generate the parser source files into.
        Returns:
        The output directory.
      • setOutputDirectory

        public void setOutputDirectory​(File outputDirectory)
        Specifies the directory to generate the parser source files into.
        Parameters:
        outputDirectory - The output directory. Must not be null.
      • getAdditionalImports

        @Input
        public List<String> getAdditionalImports()
        Returns the additional imports of the Play Routes compiler.
        Returns:
        The additional imports.
      • setAdditionalImports

        public void setAdditionalImports​(List<String> additionalImports)
        Specifies the additional imports of the Play Routes compiler.
      • isJavaProject

        @Internal
        public boolean isJavaProject()
      • setPlatform

        public void setPlatform​(PlayPlatform platform)
      • getToolChain

        @Inject
        public PlayToolChain getToolChain()
        Returns the tool chain that will be used to compile the routes source.
        Returns:
        The tool chain.
      • getForkOptions

        public BaseForkOptions getForkOptions()
        The fork options to be applied to the Routes compiler.
        Returns:
        The fork options for the Routes compiler.
      • isNamespaceReverseRouter

        @Input
        public boolean isNamespaceReverseRouter()
        Whether the reverse router should be namespaced.
      • setNamespaceReverseRouter

        public void setNamespaceReverseRouter​(boolean namespaceReverseRouter)
        Sets whether or not the reverse router should be namespaced.
      • isGenerateReverseRoutes

        @Input
        public boolean isGenerateReverseRoutes()
        Whether a reverse router should be generated. Default is true.
      • setGenerateReverseRoutes

        public void setGenerateReverseRoutes​(boolean generateReverseRoutes)
        Sets whether or not a reverse router should be generated.
      • getInjectedRoutesGenerator

        @Input
        public 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.
      • setInjectedRoutesGenerator

        public void setInjectedRoutesGenerator​(boolean injectedRoutesGenerator)
        Configure if the injected routes generator should be used to generate routes.
        Parameters:
        injectedRoutesGenerator - false - use StaticRoutesGenerator true - use InjectedRoutesGenerator