Package org.asciidoctor.gradle.model5.jvm.internal.engines

Interface LauncherParameters

  • All Superinterfaces:
    org.gradle.workers.WorkParameters
    public interface LauncherParameters
extends org.gradle.workers.WorkParameters
    Parameters for running AsciidoctorJ in a worker.
    Since:
    5.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.workers.WorkParameters

        org.gradle.workers.WorkParameters.None

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.gradle.api.provider.Property<java.lang.Boolean> getAdjustBaseDirPerFile()
      Whether to run batches based upon directories and adjust the basedir to each of these directories.
      org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String> getAttributes()
      Document attributes.
      org.gradle.api.provider.Property<java.lang.String> getBackend()
      The backend name.
      org.gradle.api.file.DirectoryProperty getBaseDir()
      Base directory.
      org.gradle.api.file.DirectoryProperty getDestinationDir()
      Destination directory.
      org.gradle.api.provider.Property<java.lang.Boolean> getEmbedded()
      Whether embedded processing should be performed.
      org.gradle.api.provider.Property<org.asciidoctor.gradle.model5.jvm.internal.engines.LauncherEngineOptions> getEngineOptions()
      asciidoctorj specific engine options.
      org.gradle.api.provider.ListProperty<java.io.File> getGroovyExtensionScriptFiles()
      List of script files that are Groovy extensions.
      org.gradle.api.provider.ListProperty<java.lang.String> getGroovyExtensionScripts()
      List of scripts that are Groovy extensions.
      org.gradle.api.file.RegularFileProperty getLogFile()
      Where logs are written to.
      org.gradle.api.provider.ListProperty<java.lang.String> getRequires()
      Classic AsciidoctorJ requires.
      org.gradle.api.provider.Property<java.lang.String> getSafeMode()
      Safe mode presented as a string.
      org.gradle.api.provider.SetProperty<java.io.File> getSourceFiles()
      Source files.
      org.gradle.api.provider.ListProperty<org.gradle.api.file.Directory> getTemplateDirs()
      Template directories for supporting backends.
      org.gradle.api.provider.Property<java.lang.String> getTemplateEngine()
      Template engine for supporting backends.

    • Method Detail

      • getSourceFiles

        org.gradle.api.provider.SetProperty<java.io.File> getSourceFiles()
        Source files.
        Returns:
        List of source files. Always present and will contain at least one source file.

      • getRequires

        org.gradle.api.provider.ListProperty<java.lang.String> getRequires()
        Classic AsciidoctorJ requires.
        Returns:
        List of required GEMs. Property is always defined, but the list could be empty.

      • getBaseDir

        org.gradle.api.file.DirectoryProperty getBaseDir()
        Base directory.
        Returns:
        Directory. Always present.

      • getAdjustBaseDirPerFile

        org.gradle.api.provider.Property<java.lang.Boolean> getAdjustBaseDirPerFile()
        Whether to run batches based upon directories and adjust the basedir to each of these directories.
        Returns:
        Flag. Always present.

      • getDestinationDir

        org.gradle.api.file.DirectoryProperty getDestinationDir()
        Destination directory.
        Returns:
        Directory. Always present.

      • getBackend

        org.gradle.api.provider.Property<java.lang.String> getBackend()
        The backend name.
        Returns:
        Backend name. Always present.

      • getSafeMode

        org.gradle.api.provider.Property<java.lang.String> getSafeMode()
        Safe mode presented as a string.
        Returns:
        Safe mode. Always present.

      • getAttributes

        org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String> getAttributes()
        Document attributes.
        Returns:
        Attributes. Always present, but can be empty.

      • getEngineOptions

        org.gradle.api.provider.Property<org.asciidoctor.gradle.model5.jvm.internal.engines.LauncherEngineOptions> getEngineOptions()
        asciidoctorj specific engine options.
        Returns:
        Engine options. Cannot be empty.

      • getLogFile

        org.gradle.api.file.RegularFileProperty getLogFile()
        Where logs are written to.
        Returns:
        Location of a log file.

      • getEmbedded

        org.gradle.api.provider.Property<java.lang.Boolean> getEmbedded()
        Whether embedded processing should be performed.
        Returns:
        Embedded flag.

      • getTemplateDirs

        org.gradle.api.provider.ListProperty<org.gradle.api.file.Directory> getTemplateDirs()
        Template directories for supporting backends.
        Returns:
        If templates are supported and were configured, this will contain one or more directories. If not supported, then this will be empty.

      • getTemplateEngine

        org.gradle.api.provider.Property<java.lang.String> getTemplateEngine()
        Template engine for supporting backends.
        Returns:
        If templates are supported and were configured, this will contain the engine. If not supported, then this will be empty.

      • getGroovyExtensionScripts

        org.gradle.api.provider.ListProperty<java.lang.String> getGroovyExtensionScripts()
        List of scripts that are Groovy extensions.
        Returns:
        List of scripts. Can be empt.

      • getGroovyExtensionScriptFiles

        org.gradle.api.provider.ListProperty<java.io.File> getGroovyExtensionScriptFiles()
        List of script files that are Groovy extensions.
        Returns:
        List of scripts. Can be empty.