org.gradle.playframework.sourcesets.internal

Class DefaultTwirlSourceSet

java.lang.Object

org.gradle.playframework.sourcesets.internal.DefaultTwirlSourceSet

All Implemented Interfaces:

TwirlSourceSet

public class DefaultTwirlSourceSet
extends Object
implements TwirlSourceSet

Constructor Summary

Constructors

Constructor and Description
DefaultTwirlSourceSet(String name, String displayName, ObjectFactory objectFactory)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTwirlSourceSet

@Inject
public DefaultTwirlSourceSet(String name,
                                     String displayName,
                                     ObjectFactory objectFactory)

Method Detail

getTwirl

public SourceDirectorySet getTwirl()

Description copied from interface: TwirlSourceSet

Returns the source directory set.

Specified by:

getTwirl in interface TwirlSourceSet

Returns:

The source directory set

twirl

public TwirlSourceSet twirl(Action<? super SourceDirectorySet> configureAction)

Description copied from interface: TwirlSourceSet

Configures the source set.

Specified by:

twirl in interface TwirlSourceSet

Parameters:

configureAction - The configuration action

Returns:

The source set

getDefaultImports

public Property<TwirlImports> getDefaultImports()

Description copied from interface: TwirlSourceSet

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

Specified by:

getDefaultImports in interface TwirlSourceSet

Returns:

The default imports

getUserTemplateFormats

public ListProperty<TwirlTemplateFormat> getUserTemplateFormats()

Description copied from interface: TwirlSourceSet

Returns the custom template formats configured for this source set.

Specified by:

getUserTemplateFormats in interface TwirlSourceSet

Returns:

The custom template formats

newUserTemplateFormat

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

Description copied from interface: TwirlSourceSet

Creates a new custom template format.

Specified by:

newUserTemplateFormat in interface TwirlSourceSet

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

public ListProperty<String> getAdditionalImports()

Description copied from interface: TwirlSourceSet

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

Specified by:

getAdditionalImports in interface TwirlSourceSet

Returns:

List of additional imports

getConstructorAnnotations

public ListProperty<String> getConstructorAnnotations()

Description copied from interface: TwirlSourceSet

Gets the list of construtor annotations to support dependency injection

Specified by:

getConstructorAnnotations in interface TwirlSourceSet

Returns:

the list of annotations included in the template constructor