Package org.gradle.docs.samples.internal

Class SampleInstallBinary

java.lang.Object

org.gradle.docs.samples.internal.SampleBinary

org.gradle.docs.samples.internal.SampleInstallBinary

All Implemented Interfaces:

org.gradle.api.Named

Direct Known Subclasses:

SampleArchiveBinary

public abstract class SampleInstallBinary
extends SampleBinary

Nested Class Summary

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

org.gradle.api.Named.Namer

Constructor Summary

Constructors

Constructor	Description
SampleInstallBinary(String name)

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.file.ConfigurableFileCollection	getContent()
abstract org.gradle.api.file.ConfigurableFileCollection	getDslSpecificContent()
abstract org.gradle.api.provider.ListProperty<String>	getExcludes()
abstract org.gradle.api.file.DirectoryProperty	getInstallDirectory()
abstract org.gradle.api.provider.Property<String>	getSampleLinkName()
abstract org.gradle.api.file.DirectoryProperty	getWorkingDirectory()

Methods inherited from class org.gradle.docs.samples.internal.SampleBinary

getName

Methods inherited from class java.lang.Object

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

Constructor Details

SampleInstallBinary

@Inject
public SampleInstallBinary(String name)

Method Details

getWorkingDirectory

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

Returns:

Working directory used by the plugin to expose an assembled sample to consumers.

getSampleLinkName

public abstract org.gradle.api.provider.Property<String> getSampleLinkName()

Returns:

The documentation page for this sample

getContent

public abstract org.gradle.api.file.ConfigurableFileCollection getContent()

Returns:

All content to include in the sample.

getDslSpecificContent

public abstract org.gradle.api.file.ConfigurableFileCollection getDslSpecificContent()

Returns:

Content that is specific to the DSL language.

getExcludes

public abstract org.gradle.api.provider.ListProperty<String> getExcludes()

Returns:

Exclude patterns for files included in this sample

getInstallDirectory

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

Returns:

A installation directory containing this sample. This can be used to get an installed version of the sample.