org.gradle.playframework.extensions

Class PlayPlatform

java.lang.Object

org.gradle.playframework.extensions.PlayPlatform

public class PlayPlatform
extends Object

Configures the Play platform used for the application including the Play version, Scala version and the Java version.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PLAY_VERSION The default Play version used if no Play version was configured.

Constructor Summary

Constructors

Constructor and Description
PlayPlatform(ObjectFactory objectFactory)

Method Summary

Modifier and Type	Method and Description
Provider<String>	getDependencyNotation(String playModule) Returns the dependency notation (group/name/version) for a given Play module including its compatible Scala version.
Property<JavaVersion>	getJavaVersion() Returns the Java version.
Property<String>	getPlayVersion() Returns the Play version.
Provider<String>	getScalaCompatibilityVersion() Returns the Scala compatibility version.
Property<String>	getScalaVersion() Returns the Scala version.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PLAY_VERSION

public static final String DEFAULT_PLAY_VERSION

The default Play version used if no Play version was configured.

See Also:

Constant Field Values

Constructor Detail

PlayPlatform

@Inject
public PlayPlatform(ObjectFactory objectFactory)

Method Detail

getPlayVersion

@Input
public Property<String> getPlayVersion()

Returns the Play version.

Used the default Play version if it wasn't configured through the extension.

Returns:

The Play version

getScalaVersion

@Input
public Property<String> getScalaVersion()

Returns the Scala version.

Uses a sensible default version based on the configured Play version if no value was provided.

Returns:

The Scala version

getScalaCompatibilityVersion

@Internal
public Provider<String> getScalaCompatibilityVersion()

Returns the Scala compatibility version.

The Scala compatibility version is comprised of the major and minor version of the configured Scala version. For example, the compatibility version of Scala 2.12.2 is 2.12.

Returns:

The Scala compatibility version

See Also:

getScalaVersion()

getJavaVersion

@Input
public Property<JavaVersion> getJavaVersion()

Returns the Java version.

Uses a sensible default version based on the configured Play version if no value was provided.

Returns:

The Java version

getDependencyNotation

public Provider<String> getDependencyNotation(String playModule)

Returns the dependency notation (group/name/version) for a given Play module including its compatible Scala version.

For example, the dependency notation for the Play module "play-docs" for Play 2.6.15 and Scala 2.12.2 would evaluate to "com.typesafe.play:play-docs_2.12:2.6.15".

Parameters:

playModule - The Play module

Returns:

The dependency notation

See Also:

getScalaCompatibilityVersion()