BaseAsciidoctorJSModules (asciidoctor-gradle-js 4.0.0 API)

org.asciidoctor.gradle.js.base.internal.BaseAsciidoctorJSModules

All Implemented Interfaces and Traits:: AsciidoctorJSModules

@SuppressWarnings(value: [ConfusingMethodName, ClassName])
@groovy.transform.CompileStatic
class BaseAsciidoctorJSModules
extends Object
implements AsciidoctorJSModules

Define versions for standard AsciidoctorJS modules.

Authors:: Schalk W. Cronjé

Since:: 3.0

Constructor Summary

Constructors
Constructor and description
`BaseAsciidoctorJSModules (org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, org.asciidoctor.gradle.base.AsciidoctorModuleDefinition docbook)` Creates a module definition that is attached to a specific asciidoctorjs extension.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`docbook(groovy.lang.Closure cfg)` Configure docbook via closure.
	`void`	`docbook(Action<AsciidoctorModuleDefinition> cfg)` Configure docbook via an action.
	`org.asciidoctor.gradle.base.AsciidoctorModuleDefinition`	`getByName(String name)` Returns a module by name
	`org.asciidoctor.gradle.base.AsciidoctorModuleDefinition`	`getDocbook()` The Docbook module
	`boolean`	`isSetVersionsDifferentTo(AsciidoctorJSModules other)` For the modules that are configured in both module sets, compare to see if the versions are the same
	`void`	`onUpdate(Action<AsciidoctorJSModules> callback)`
	`protected void`	`updateNow()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - @SuppressWarnings(value: UnnecessarySetter) BaseAsciidoctorJSModules(org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, org.asciidoctor.gradle.base.AsciidoctorModuleDefinition docbook)
    
    Creates a module definition that is attached to a specific asciidoctorjs extension.
    Parameters:
    asciidoctorjs - Extension that this module is attached to.
    Since:
    4.0
- Method Detail
  - @Override void docbook(@groovy.lang.DelegatesTo(value: AsciidoctorModuleDefinition) groovy.lang.Closure cfg)
    
    Configure docbook via closure.
    Parameters:
    cfg - Configurating closure
  - @Override void docbook(Action<AsciidoctorModuleDefinition> cfg)
    
    Configure docbook via an action.
    Parameters:
    cfg - Configurator
  - @Override org.asciidoctor.gradle.base.AsciidoctorModuleDefinition getByName(String name)
    
    Returns a module by name
    throws:
    org.asciidoctor.gradle.base.ModuleNotFoundException when the module is not registered.
    
    Parameters:
    name - Name of module
    Returns:
    Module
  - @Override org.asciidoctor.gradle.base.AsciidoctorModuleDefinition getDocbook()
    
    The Docbook module
    Returns:
    Access to the Docbook module. Never null.
  - @Override boolean isSetVersionsDifferentTo(AsciidoctorJSModules other)
    
    For the modules that are configured in both module sets, compare to see if the versions are the same
    Parameters:
    other - Other module set to compare.
  - void onUpdate(Action<AsciidoctorJSModules> callback)
  - protected void updateNow()

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class BaseAsciidoctorJSModules

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@SuppressWarnings(value: UnnecessarySetter) BaseAsciidoctorJSModules(org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, org.asciidoctor.gradle.base.AsciidoctorModuleDefinition docbook)

Method Detail

@Override void docbook(@groovy.lang.DelegatesTo(value: AsciidoctorModuleDefinition) groovy.lang.Closure cfg)

@Override void docbook(Action<AsciidoctorModuleDefinition> cfg)

@Override org.asciidoctor.gradle.base.AsciidoctorModuleDefinition getByName(String name)

@Override org.asciidoctor.gradle.base.AsciidoctorModuleDefinition getDocbook()

@Override boolean isSetVersionsDifferentTo(AsciidoctorJSModules other)

void onUpdate(Action<AsciidoctorJSModules> callback)

protected void updateNow()