org.asciidoctor.gradle.base

Interface AsciidoctorTaskBaseDirConfiguration

All Known Subinterfaces:

AsciidoctorTaskMethods

public interface AsciidoctorTaskBaseDirConfiguration

Asciidoctor base directories need special care and those methods are specified by this interface.

Getters in this interface are all annotated with Internal as they should be participate in task properties for up to date checks.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	baseDirFollowsSourceDir() The base dir will be the same as the source directory.
void	baseDirFollowsSourceFile() Sets the basedir to be the same directory as each individual source file.
void	baseDirIsProjectDir() Sets the basedir to be the same directory as the current project directory.
void	baseDirIsRootProjectDir() Sets the basedir to be the same directory as the root project directory.
default java.io.File	getBaseDir() Base directory (current working directory) for a conversion.
java.io.File	getBaseDir(java.lang.String lang) Base directory (current working directory) for a conversion.
org.gradle.api.provider.Provider<java.io.File>	getBaseDirProvider() Provider of the base directory.
org.asciidoctor.gradle.base.BaseDirStrategy	getBaseDirStrategy() Returns the current basedir strategy if it has been configured.
boolean	isBaseDirConfigured() Checks whether an explicit strategy has been set for base directory.
void	setBaseDir(java.lang.Object f) Sets the base directory for a conversion.

Method Detail

baseDirFollowsSourceDir

void baseDirFollowsSourceDir()

The base dir will be the same as the source directory.

If an intermediate working directory is used, the the base dir will be where the source directory is located within the temporary working directory.

baseDirFollowsSourceFile

void baseDirFollowsSourceFile()

Sets the basedir to be the same directory as each individual source file.

baseDirIsProjectDir

void baseDirIsProjectDir()

Sets the basedir to be the same directory as the current project directory.

Since:

2.2.0

baseDirIsRootProjectDir

void baseDirIsRootProjectDir()

Sets the basedir to be the same directory as the root project directory.

getBaseDir

@Internal
 @Nullable
default java.io.File getBaseDir()

Base directory (current working directory) for a conversion.

Returns:

Base directory. Can be null

getBaseDir

java.io.File getBaseDir(java.lang.String lang)

Base directory (current working directory) for a conversion. Depending on the strateggy in use, the source language used in the conversion may change the final base directory relative to the value returned by getBaseDir().

Parameters:

lang - Language in use

Returns:

Language-dependent base directory

getBaseDirProvider

@Internal
org.gradle.api.provider.Provider<java.io.File> getBaseDirProvider()

Provider of the base directory.

Returns:

Base dir. Can be an empty provider.

getBaseDirStrategy

@Nullable
 @Internal
org.asciidoctor.gradle.base.BaseDirStrategy getBaseDirStrategy()

Returns the current basedir strategy if it has been configured.

Returns:

Strategy or @{code null}.

isBaseDirConfigured

@Internal
boolean isBaseDirConfigured()

Checks whether an explicit strategy has been set for base directory.

Returns:

true if a strategy has been configured.

setBaseDir

void setBaseDir(java.lang.Object f)

Sets the base directory for a conversion.

The base directory is used by AsciidoctorJ to set a current working directory for a conversion. If never set, then project.projectDir will be assumed to be the base directory.

Parameters:

f - Base directory