Package org.gradle.docs.samples.internal

Class SamplesInternal

java.lang.Object
org.gradle.docs.samples.internal.SamplesInternal
All Implemented Interfaces:
Samples
public abstract class SamplesInternal extends Object implements Samples

  • Constructor Details

    • SamplesInternal

      @Inject public SamplesInternal(org.gradle.api.model.ObjectFactory objectFactory)

  • Method Details

    • getPublishedSamples

      public org.gradle.api.NamedDomainObjectContainer<? extends SampleInternal> getPublishedSamples()
      Specified by:
      getPublishedSamples in interface Samples
      Returns:
      Container of all published samples. This is the primary configuration point for all samples.

    • getBinaries

      public org.gradle.api.DomainObjectSet<? super SampleBinary> getBinaries()

    • getTemplates

      public org.gradle.api.NamedDomainObjectContainer<? extends TemplateInternal> getTemplates()
      Specified by:
      getTemplates in interface Samples
      Returns:
      Container of all templates. Templates are reusable parts of a sample.

    • getDistribution

      public SamplesDistribution getDistribution()
      Specified by:
      getDistribution in interface Samples
      Returns:
      Buildable elements of all the available samples.

    • getInstallRoot

      public abstract org.gradle.api.file.DirectoryProperty getInstallRoot()
      By convention, this is buildDir/working/samples/install
      Returns:
      The root install directory.

    • getTestedInstallRoot

      public abstract org.gradle.api.file.DirectoryProperty getTestedInstallRoot()
      By convention, this is buildDir/working/samples/testing
      Returns:
      location of installed samples ready for testing

    • getDocumentationInstallRoot

      public abstract org.gradle.api.file.DirectoryProperty getDocumentationInstallRoot()
      By convention, this is buildDir/working/samples/docs
      Returns:
      The root directory for all documentation.

    • getRenderedDocumentationRoot

      public abstract org.gradle.api.file.DirectoryProperty getRenderedDocumentationRoot()
      By convention, this is buildDir/working/samples/render-samples
      Returns:
      The root directory for rendered documentation.