org.asciidoctor.gradle.model5.core.basedir

Interface BaseDirConfiguration

public interface BaseDirConfiguration

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

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	baseDirFollowsSourceDir() The base dir will be the same as the source directory.
void	baseDirFollowsSourceFiles() The base directory starts with the source directory but needs to adjust to the parent file of each file it processes.
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.
org.gradle.api.provider.Provider<BaseDirStrategy>	getBaseDirStrategy() Returns the current basedir strategy if it has been configured.
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 base dir will be where the source directory is located within the temporary working directory.

baseDirIsProjectDir

void baseDirIsProjectDir()

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

baseDirIsRootProjectDir

void baseDirIsRootProjectDir()

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

baseDirFollowsSourceFiles

void baseDirFollowsSourceFiles()

The base directory starts with the source directory but needs to adjust to the parent file of each file it processes.

Keep in mind that this will probably invoke a performance penalty.

getBaseDirStrategy

org.gradle.api.provider.Provider<BaseDirStrategy> getBaseDirStrategy()

Returns the current basedir strategy if it has been configured.

Returns:

Strategy or empty provider.

setBaseDir

void setBaseDir(java.lang.Object f)

Sets the base directory for a conversion.

Parameters:

f - Base directory