AsciidoctorJSetup (asciidoctor-gradle-jvm 4.0.2 API)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.asciidoctor.gradle.remote.AsciidoctorJSetup

All Implemented Interfaces and Traits:

Serializable
```
@groovy.transform.CompileStatic
class AsciidoctorJSetup
extends Object
implements Serializable
```
Sets AsciidoctorJ runtime.
Authors:
Schalk W. Cronjé
Since:
4.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`ATTR_PROJECT_DIR`
`static String`	`ATTR_REL_SRC_DIR`
`static String`	`ATTR_ROOT_DIR`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorJSetup ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getRelativePath(File target, File base)` Returns the path of one File relative to another.
	`Map<String, Object>`	`normalisedOptionsFor(File file, ExecutorConfiguration runConfiguration)` Normalises Asciidoctor options for a given source file.
	`List<Object>`	`rehydrateExtensions(Object registry, List<Object> exts)` Rehydrates docExtensions that were serialised.

Inherited Methods Summary

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

- Field Detail
  - public static final String ATTR_PROJECT_DIR
  - public static final String ATTR_REL_SRC_DIR
  - public static final String ATTR_ROOT_DIR
- Constructor Detail
  - AsciidoctorJSetup()
- Method Detail
  - String getRelativePath(File target, File base)
    
    Returns the path of one File relative to another.
    throws:
    IOException if an error occurs while resolving the files' canonical names
    
    Parameters:
    target - the target directory
    base - the base directory
    Returns:
    target's path relative to the base directory
  - @SuppressWarnings(value: DuplicateStringLiteral ) Map<String, Object> normalisedOptionsFor(File file, ExecutorConfiguration runConfiguration)
    
    Normalises Asciidoctor options for a given source file. Relativizes certain attributes and ensure specific options for backend, sage mode and output directory are in place.
    Parameters:
    file - Source file to be converted
    runConfiguration - The current executor configuration
    Returns:
    Asciidoctor options
  - List<Object> rehydrateExtensions(Object registry, List<Object> exts)
    
    Rehydrates docExtensions that were serialised.
    Parameters:
    registry - Asciidoctor GroovyDSL registry instance.
    exts - List of docExtensions to rehydrate.
    Returns:
    List of rehydrated extensions

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Copyright © 2013-2024 the original author or authors. All rights reserved.