Package org.gradle.docs.samples.internal

Class SampleArchiveBinary

java.lang.Object

org.gradle.docs.samples.internal.SampleBinary

org.gradle.docs.samples.internal.SampleInstallBinary

org.gradle.docs.samples.internal.SampleArchiveBinary

All Implemented Interfaces:

org.gradle.api.Named

public abstract class SampleArchiveBinary
extends SampleInstallBinary

Represents a sample tailored for a particular DSL.

Nested Class Summary

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

org.gradle.api.Named.Namer

Constructor Summary

Constructors

Constructor	Description
SampleArchiveBinary(String name)

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.Property<Dsl>	getDsl()
abstract org.gradle.api.file.RegularFileProperty	getValidationReport()
abstract org.gradle.api.file.RegularFileProperty	getZipFile()

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

getContent, getDslSpecificContent, getExcludes, getInstallDirectory, getSampleLinkName, 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

SampleArchiveBinary

@Inject
public SampleArchiveBinary(String name)

Method Details

getDsl

public abstract org.gradle.api.provider.Property<Dsl> getDsl()

Returns:

The language this sample is written for

getValidationReport

public abstract org.gradle.api.file.RegularFileProperty getValidationReport()

Returns:

Gets the validation report for this sample.

getZipFile

public abstract org.gradle.api.file.RegularFileProperty getZipFile()

Returns:

A zip containing this sample. This is the primary thing produced by a sample for a given language.