AbstractImplementationEngineExtension (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.AbstractImplementationEngineExtension

All Implemented Interfaces and Traits:: AsciidoctorAttributeProvider

@groovy.transform.CompileStatic
class AbstractImplementationEngineExtension
extends org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase
implements AsciidoctorAttributeProvider

Base class for implementing extensions in the Asciidoctor Gradle suite. This class is engine agnostic.

Since:: 3.0

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase`	`__$stMC`

Properties Summary

Properties
Type	Name and description
`Map<String, Object>`	`attributes`
`SafeMode`	`safeMode`
`SafeMode`	`safeMode`
`SafeMode`	`safeMode`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`attribute(String key, Object value)` Add a single attribute
	`void`	`attributeProvider(AsciidoctorAttributeProvider provider)` Adds an additional attribute provider.
	`void`	`attributeProvider(groovy.lang.Closure provider)` Adds a closure as an additional attribute provider.
	`void`	`attributes(Map m)` Add additional Asciidoctor attributes.
	`void`	`attributesForLang(Map<String, Object> m, String lang)` Add additional Asciidoctor attributes.
	`List<AsciidoctorAttributeProvider>`	`getAttributeProviders()` Returns a list of additional attribute providers.
	`Map<String, Object>`	`getAttributes()` Resolves all of the Asciidoctor options.
	`Map<String, Object>`	`getAttributesForLang(String lang)` Returns all of the Asciidoctor attributes for a specific language.
	`SafeMode`	`getSafeMode()` Returns the Asciidoctor SafeMode under which a conversion will be run.
	`void`	`resetAttributesForLang(Map<String, Object> m, String lang)` Apply a new set of Asciidoctor language-specific attributes, clearing any language-specific attributes previously set.
	`void`	`setAttributes(Map m)` Apply a new set of Asciidoctor attributes, clearing any attributes previously set.
	`void`	`setSafeMode(SafeMode mode)` Set Asciidoctor safe mode.
	`void`	`setSafeMode(int mode)` Set Asciidoctor safe mode.
	`void`	`setSafeMode(String mode)` Set Asciidoctor safe mode.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase`	org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#getMetaClass(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#invokeMethod(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#getProjectOperations(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#getProperty(java.lang.String), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#wait(long, int), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#wait(long), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#wait(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#equals(java.lang.Object), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#toString(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#hashCode(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#getClass(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#notify(), org.ysb33r.grolifant.api.core.runnable.CombinedProjectTaskExtensionBase#notifyAll()

- Property Detail
  - Map<String, Object> attributes
  - SafeMode safeMode
  - SafeMode safeMode
  - SafeMode safeMode
- Method Detail
  - void attribute(String key, Object value)
    
    Add a single attribute
    Parameters:
    key - Name of attribute
    value - Value of attribute.
    Since:
    3.0
  - void attributeProvider(AsciidoctorAttributeProvider provider)
    
    Adds an additional attribute provider.
    Parameters:
    provider
  - void attributeProvider(groovy.lang.Closure provider)
    
    Adds a closure as an additional attribute provider.
    Parameters:
    provider - A closure must return a Map
  - @SuppressWarnings(value: ConfusingMethodName) void attributes(Map m)
    
    Add additional Asciidoctor attributes. This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will use this attributes in the task in addition to any global attributes.
    Parameters:
    m - Map with new options
  - @SuppressWarnings(value: ConfusingMethodName) void attributesForLang(Map<String, Object> m, String lang)
    
    Add additional Asciidoctor attributes. This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will use this attributes in the task in addition to any global attributes.
    Parameters:
    m - Map with additional language-specific attributes.
    lang - Language for which attributes need to be reset.
  - List<AsciidoctorAttributeProvider> getAttributeProviders()
    
    Returns a list of additional attribute providers.
    Returns:
    List of providers. Can be empty. Never null.
  - Map<String, Object> getAttributes()
    
    Resolves all of the Asciidoctor options.
    Returns:
    A map of resovled attributes
  - Map<String, Object> getAttributesForLang(String lang)
    
    Returns all of the Asciidoctor attributes for a specific language.
    Parameters:
    lang - Language for which attributes need to be returned
    Returns:
    Can be empty. Never null
  - SafeMode getSafeMode()
    
    Returns the Asciidoctor SafeMode under which a conversion will be run.
    Returns:
    Asciidoctor Safe Mode
  - void resetAttributesForLang(Map<String, Object> m, String lang)
    
    Apply a new set of Asciidoctor language-specific attributes, clearing any language-specific attributes previously set. This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will override the global attributes for the specific language.
    Parameters:
    m - Map with new language-specific attributes
    lang - Language for which attributes need to be reset.
  - void setAttributes(Map m)
    
    Apply a new set of Asciidoctor attributes, clearing any attributes previously set. This can be set globally for all Asciidoctor tasks in a project. If this is set in a task it will override the global attributes.
    Parameters:
    m - Map with new options
  - void setSafeMode(SafeMode mode)
    
    Set Asciidoctor safe mode.
    Parameters:
    mode - An instance of Asciidoctor SafeMode.
  - void setSafeMode(int mode)
    
    Set Asciidoctor safe mode.
    Parameters:
    mode - A valid integer representing a Safe Mode
  - void setSafeMode(String mode)
    
    Set Asciidoctor safe mode.
    Parameters:
    mode - A valid string representing a Safe Mode

Summary:
Property
Method

| Detail:
Property
Method

[Groovy] Class AbstractImplementationEngineExtension

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

Map<String, Object> attributes

SafeMode safeMode

SafeMode safeMode

SafeMode safeMode

Method Detail

void attribute(String key, Object value)

void attributeProvider(AsciidoctorAttributeProvider provider)

void attributeProvider(groovy.lang.Closure provider)

@SuppressWarnings(value: ConfusingMethodName) void attributes(Map m)

@SuppressWarnings(value: ConfusingMethodName) void attributesForLang(Map<String, Object> m, String lang)

List<AsciidoctorAttributeProvider> getAttributeProviders()

Map<String, Object> getAttributes()

Map<String, Object> getAttributesForLang(String lang)

SafeMode getSafeMode()

void resetAttributesForLang(Map<String, Object> m, String lang)

void setAttributes(Map m)

void setSafeMode(SafeMode mode)

void setSafeMode(int mode)

void setSafeMode(String mode)