org.asciidoctor.gradle.base

Class AbstractDownloadableComponent<ComponentSrc,ResolvedComponent>

java.lang.Object

org.asciidoctor.gradle.base.AbstractDownloadableComponent<ComponentSrc,ResolvedComponent>

Type Parameters:

ComponentSrc - Source component type

ResolvedComponent - Final component type

public abstract class AbstractDownloadableComponent<ComponentSrc,ResolvedComponent>
extends java.lang.Object

Base class for building extension which can allows styles and themes to be added to various Asciidoctor backends that may require them.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.ysb33r.grolifant5.api.core.ProjectOperations	projectOperations Re-usable instance of ProjectOperations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDownloadableComponent(org.gradle.api.Project project) Protected c-tor.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.concurrent.Callable<ResolvedComponent>	convertible(ComponentSrc component) Create a closure that will convert an instance of a ComponentSrc into a ResolvedComponent.
protected java.util.concurrent.Callable<ResolvedComponent>	convertible(java.lang.String name, org.ysb33r.grolifant5.api.core.git.AbstractCloudGit component) Creates a closure that can convert from a GitLab/GitHub repository to a local cached file.
ResolvedComponent	getByName(java.lang.String name) Retrieve a component by name.
void	github(java.lang.String name, org.gradle.api.Action<org.asciidoctor.gradle.base.AscGitHubArchive> githubConfig) Use a GitHub repository as a theme.
void	gitlab(java.lang.String name, org.gradle.api.Action<org.asciidoctor.gradle.base.AscGitLabArchive> gitlabConfig) Use a GitLab repository as a theme.
void	gitlab(java.lang.String name, groovy.lang.Closure<?> gitlabConfig) Use a GitLab repository as a theme.
protected abstract ComponentSrc	instantiateComponentSource(java.lang.String name) Instantiates a component of type ComponentSrc.
protected abstract ResolvedComponent	instantiateResolvedComponent(java.lang.String name, java.io.File path) Instantiates a resolved component.
void	local(java.lang.String name, org.gradle.api.Action<ComponentSrc> localConfig) Adds a component source that is available on the local filesystem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

projectOperations

protected final org.ysb33r.grolifant5.api.core.ProjectOperations projectOperations

Re-usable instance of ProjectOperations

Constructor Detail

AbstractDownloadableComponent

protected AbstractDownloadableComponent(org.gradle.api.Project project)

Protected c-tor.

Parameters:

project - Temporary project reference.

Method Detail

local

public void local(java.lang.String name,
                  org.gradle.api.Action<ComponentSrc> localConfig)

Adds a component source that is available on the local filesystem.

By default, the styleName will match that of the theme. If the name ends with .yml, it’s assumed to be the complete name of a file. Otherwise, -theme.yml is appended to the name to make the file name (i.e., <name>-theme.yml).

Parameters:

name - Name of theme

localConfig - Configures an instance of ComponentSrc.

github

public void github(java.lang.String name,
                   org.gradle.api.Action<org.asciidoctor.gradle.base.AscGitHubArchive> githubConfig)

Use a GitHub repository as a theme.

Parameters:

name - Name of theme

githubConfig - Action to configure a AscGitHubArchive.

gitlab

public void gitlab(java.lang.String name,
                   @DelegatesTo(value=org.ysb33r.grolifant5.api.core.git.GitLabArchive.class)
                   groovy.lang.Closure<?> gitlabConfig)

Use a GitLab repository as a theme.

Parameters:

name - Name of theme

gitlabConfig - Closure to configure a AscGitLabArchive.

gitlab

public void gitlab(java.lang.String name,
                   org.gradle.api.Action<org.asciidoctor.gradle.base.AscGitLabArchive> gitlabConfig)

Use a GitLab repository as a theme.

Parameters:

name - Name of theme

gitlabConfig - Action to configure a AscGitLabArchive.

getByName

public ResolvedComponent getByName(java.lang.String name)

Retrieve a component by name.

If the component has not already been resolved, it will be resolved by this call.

Parameters:

name - Name of the component.

Returns:

Resolved component.

Throws:

org.gradle.api.UnknownDomainObjectException - is the component has not been registered.

convertible

protected java.util.concurrent.Callable<ResolvedComponent> convertible(java.lang.String name,
                                                                       org.ysb33r.grolifant5.api.core.git.AbstractCloudGit component)

Creates a closure that can convert from a GitLab/GitHub repository to a local cached file.

Parameters:

name - Name or componenet

component - Details of component in remote repository.

Returns:

Closure that will resolve an archive from a remote repository and store it locally.

instantiateComponentSource

protected abstract ComponentSrc instantiateComponentSource(java.lang.String name)

Instantiates a component of type ComponentSrc.

Parameters:

name - Name of componenet

Returns:

New component source description

convertible

protected abstract java.util.concurrent.Callable<ResolvedComponent> convertible(ComponentSrc component)

Create a closure that will convert an instance of a ComponentSrc into a ResolvedComponent.

Parameters:

component - Component to be converted.

Returns:

Converting closure.

instantiateResolvedComponent

protected abstract ResolvedComponent instantiateResolvedComponent(java.lang.String name,
                                                                  java.io.File path)

Instantiates a resolved component.

Parameters:

name - Name of component

path - Path to where compoenet is located on local filesystem.

Returns:

Instantiated component.