Package org.asciidoctor.gradle.model5.jvm.toolchains

Interface AsciidoctorjToolchain

  • All Superinterfaces:
    org.asciidoctor.gradle.model5.core.engines.AsciidoctorEngine, org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain, ClasspathManagement, CoreVersions, org.asciidoctor.gradle.model5.core.HasDisplayType, org.gradle.api.Named, org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions
    public interface AsciidoctorjToolchain
extends org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain, CoreVersions, ClasspathManagement
    A toolchain for running asciidoctorj.
    Since:
    5.0

    • Nested Class Summary

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

        org.gradle.api.Named.Namer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void engineOptions​(groovy.lang.Closure<?> configurator)
      Configures additional engine options.
      void engineOptions​(org.gradle.api.Action<EngineOptions> configurator)
      Configures additional engine options.
      EngineOptions getEngineOptions()
      Direct access to engine options.
      void registerExecutionContext​(java.lang.String formatterName, org.gradle.api.provider.Provider<ExecutionContext> executionContext)
      An interface primarily used by output formatters to register context.

      • Methods inherited from interface org.asciidoctor.gradle.model5.core.engines.AsciidoctorEngine

        getLauncher

      • Methods inherited from interface org.asciidoctor.gradle.model5.core.toolchains.AsciidoctorToolchain

        getAsciidocExtensions, getRegisteredOutputFormatters, getToolchainPreparationTaskNames

      • Methods inherited from interface org.asciidoctor.gradle.model5.core.HasDisplayType

        getDisplayType

      • Methods inherited from interface org.gradle.api.Named

        getName

      • Methods inherited from interface org.asciidoctor.gradle.model5.core.toolchains.ProcessingOptions

        getSafeMode, isLogDocuments, setLogDocuments, setSafeMode, setSafeMode, setSafeMode, setSafeMode

    • Method Detail

      • engineOptions

        void engineOptions​(org.gradle.api.Action<EngineOptions> configurator)
        Configures additional engine options.
        Parameters:
        configurator - Configurator which is passed an instance of EngineOptions

      • engineOptions

        void engineOptions​(@DelegatesTo(EngineOptions.class)
                   groovy.lang.Closure<?> configurator)
        Configures additional engine options.
        Parameters:
        configurator - Configurator which is passed an instance of EngineOptions

      • getEngineOptions

        EngineOptions getEngineOptions()
        Direct access to engine options.
        Returns:
        Instance of something that implements EngineOptions

      • registerExecutionContext

        void registerExecutionContext​(java.lang.String formatterName,
                              org.gradle.api.provider.Provider<ExecutionContext> executionContext)
        An interface primarily used by output formatters to register context.
        Parameters:
        formatterName - An active asciidoctorj formatter.
        executionContext - Valid execution context. The provider can be empty which will mean the same as no execution context.