Package org.asciidoctor.gradle.model5.jvm.components

Interface AsciidoctorjGenericComponent

All Known Subinterfaces:

AsciidoctorjGenericExtension, AsciidoctorjGenericOutputFormatter

public interface AsciidoctorjGenericComponent

Methods for adding a generic component (backend or extension) to asciidoctorj

Since:

5.0

Method Summary

Modifier and Type	Method	Description
void	attributes(java.util.Map<java.lang.String,?> attrs)	Attributes that are specific to the backend.
void	requires(java.lang.String... reqs)	If the backend needs one or more require entries to be passed to the engine, put it here.
void	useGem(java.lang.String gemName, java.lang.Object version)	If the backend is provided by a GEM, then set it here.
void	useModule(java.lang.String moduleName, java.lang.Object version)	If the backend is provided by an artifact from a Maven or Ivy repository, then set it here.
void	useModule(org.gradle.api.artifacts.ProjectDependency module)	If the backend is produced in the current hierarchy it can be used via a ProjectDependency.

Method Detail

useGem

void useGem(java.lang.String gemName,
            java.lang.Object version)

If the backend is provided by a GEM, then set it here.

Requires org.asciidoctor.jvm.gems to be applied, otherwise an error will be raised.

One of useGem(String, Object) or useModule(String, Object) is required.

Parameters:

gemName - Name of GEM

version - Something convertible to a string that can provide the version.

useModule

void useModule(java.lang.String moduleName,
               java.lang.Object version)

If the backend is provided by an artifact from a Maven or Ivy repository, then set it here.

One of useGem(String, Object) or useModule(String, Object) is required

Parameters:

moduleName - A module in the format group:artifact.

version - Something convertible to a string that can provide the version.

useModule

void useModule(org.gradle.api.artifacts.ProjectDependency module)

If the backend is produced in the current hierarchy it can be used via a ProjectDependency.

Parameters:

module - Project module.

requires

void requires(java.lang.String... reqs)

If the backend needs one or more require entries to be passed to the engine, put it here.

Parameters:

reqs - One or more require entries

attributes

void attributes(java.util.Map<java.lang.String,?> attrs)

Attributes that are specific to the backend.

Parameters:

attrs - Attributes of which the values are lazy-evaluated.