org.gradle.playframework.sourcesets

Interface TwirlSourceSet

All Known Implementing Classes:

DefaultTwirlSourceSet

public interface TwirlSourceSet

Represents a source set containing Twirl templates.

The following example demonstrate the use of the source set in a build script using the Groovy DSL:

 sourceSets {
     main {
         twirl {
             userTemplateFormats.add(newUserTemplateFormat('csv', 'views.formats.csv.CsvFormat', 'views.formats.csv._'))
             additionalImports = ['my.pkg._', 'my.pkg.MyClass']
         }
     }
 }
 

Method Summary

Modifier and Type	Method and Description
ListProperty<String>	getAdditionalImports() Returns the list of additional imports to add to the generated Scala code.
ListProperty<String>	getConstructorAnnotations() Gets the list of construtor annotations to support dependency injection
Property<TwirlImports>	getDefaultImports() The default imports that should be added to generated source files.
SourceDirectorySet	getTwirl() Returns the source directory set.
ListProperty<TwirlTemplateFormat>	getUserTemplateFormats() Returns the custom template formats configured for this source set.
TwirlTemplateFormat	newUserTemplateFormat(String extension, String templateType, String... imports) Creates a new custom template format.
TwirlSourceSet	twirl(Action<? super SourceDirectorySet> configureAction) Configures the source set.

Method Detail

getTwirl

SourceDirectorySet getTwirl()

Returns the source directory set.

Returns:

The source directory set

twirl

TwirlSourceSet twirl(Action<? super SourceDirectorySet> configureAction)

Configures the source set.

Parameters:

configureAction - The configuration action

Returns:

The source set

getDefaultImports

Property<TwirlImports> getDefaultImports()

The default imports that should be added to generated source files.

Returns:

The default imports

getUserTemplateFormats

ListProperty<TwirlTemplateFormat> getUserTemplateFormats()

Returns the custom template formats configured for this source set.

Returns:

The custom template formats

newUserTemplateFormat

TwirlTemplateFormat newUserTemplateFormat(String extension,
                                          String templateType,
                                          String... imports)

Creates a new custom template format.

Parameters:

extension - The 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

Returns:

The new custom template format

getAdditionalImports

ListProperty<String> getAdditionalImports()

Returns the list of additional imports to add to the generated Scala code.

Returns:

List of additional imports

getConstructorAnnotations

ListProperty<String> getConstructorAnnotations()

Gets the list of construtor annotations to support dependency injection

Returns:

the list of annotations included in the template constructor