org.gradle.docs.samples.internal

Class SampleInternal

java.lang.Object

org.gradle.docs.samples.internal.SampleInternal

All Implemented Interfaces:

org.gradle.api.Named, Sample, SampleSummary

public abstract class SampleInternal
extends java.lang.Object
implements Sample

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

org.gradle.api.Named.Namer

Constructor Summary

Constructors

Constructor and Description
SampleInternal(java.lang.String name, org.gradle.api.tasks.TaskContainer tasks)

Method Summary

Modifier and Type	Method and Description
void	common(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action) Configure common content.
org.gradle.api.tasks.TaskProvider<org.gradle.api.Task>	getAssembleTask()
org.gradle.api.tasks.TaskProvider<org.gradle.api.Task>	getCheckTask()
abstract org.gradle.api.file.DirectoryProperty	getInstallDirectory()
java.lang.String	getName()
void	groovy(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action) Configure Groovy content.
void	kotlin(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action) Configure Kotlin content.
void	tests(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action) Configure testing content.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.docs.samples.Sample

getCommonContent, getGroovyContent, getKotlinContent, getReadmeFile, getSampleDirectory, getTestsContent

Methods inherited from interface org.gradle.docs.samples.SampleSummary

getCategory, getDescription, getDisplayName, getDsls, getPromoted, getSampleDocName

Constructor Detail

SampleInternal

@Inject
public SampleInternal(java.lang.String name,
                              org.gradle.api.tasks.TaskContainer tasks)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.gradle.api.Named

common

public void common(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action)

Description copied from interface: Sample

Configure common content.

Specified by:

common in interface Sample

Parameters:

action - configuration action

groovy

public void groovy(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action)

Description copied from interface: Sample

Configure Groovy content.

Specified by:

groovy in interface Sample

Parameters:

action - configuration action

kotlin

public void kotlin(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action)

Description copied from interface: Sample

Configure Kotlin content.

Specified by:

kotlin in interface Sample

Parameters:

action - configuration action

tests

public void tests(org.gradle.api.Action<? super org.gradle.api.file.ConfigurableFileCollection> action)

Description copied from interface: Sample

Configure testing content.

Specified by:

tests in interface Sample

Parameters:

action - configuration action

getAssembleTask

public org.gradle.api.tasks.TaskProvider<org.gradle.api.Task> getAssembleTask()

Returns:

Lifecycle task for assembling this sample.

getCheckTask

public org.gradle.api.tasks.TaskProvider<org.gradle.api.Task> getCheckTask()

Returns:

Lifecycle task for checking this sample.

getInstallDirectory

public abstract org.gradle.api.file.DirectoryProperty getInstallDirectory()

Returns:

Root installation directory for each DSL.