Class TwirlCompile

    • Constructor Detail

      • TwirlCompile

        public TwirlCompile()
    • Method Detail

      • getForkOptions

        public BaseForkOptions getForkOptions()
        fork options for the twirl compiler.
      • getOutputDirectory

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

        @Input
        public Object getDependencyNotation()
      • 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.
      • getDefaultImports

        @Optional
        @Input
        public TwirlImports getDefaultImports()
        Returns the default imports that will be used when compiling templates.
        Returns:
        The imports that will be used.
      • setDefaultImports

        public void setDefaultImports​(TwirlImports defaultImports)
        Sets the default imports to be used when compiling templates.
        Parameters:
        defaultImports - The imports to be used.
      • setPlatform

        public void setPlatform​(PlayPlatform platform)
      • getToolChain

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

        public void setToolChain​(PlayToolChain toolChain)
        Sets the tool chain that will be used to compile the twirl source.
        Parameters:
        toolChain - The tool chain.
      • getUserTemplateFormats

        @Input
        public List<TwirlTemplateFormat> getUserTemplateFormats()
        Returns the custom template formats configured for this task.
        Since:
        4.2
      • setUserTemplateFormats

        public void setUserTemplateFormats​(List<TwirlTemplateFormat> userTemplateFormats)
        Sets the custom template formats for this task.
        Since:
        4.2
      • addUserTemplateFormat

        public void addUserTemplateFormat​(String extension,
                                          String templateType,
                                          String... imports)
        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

        @Input
        public List<String> getAdditionalImports()
        Returns the list of additional imports to add to the generated Scala code.
        Since:
        4.2
      • setAdditionalImports

        public void setAdditionalImports​(List<String> additionalImports)
        Sets the additional imports to add to all generated Scala code.
        Parameters:
        additionalImports - additional imports
        Since:
        4.2