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.
| Type Params | Return Type | Name and description |
|---|---|---|
|
public void |
baseDirFollowsSourceDir()The base dir will be the same as the source directory. |
|
public void |
baseDirFollowsSourceFile()Sets the basedir to be the same directory as each individual source file. |
|
public void |
baseDirIsProjectDir()Sets the basedir to be the same directory as the current project directory. |
|
public void |
baseDirIsRootProjectDir()Sets the basedir to be the same directory as the root project directory. |
|
public File |
getBaseDir()Base directory (current working directory) for a conversion. |
|
public File |
getBaseDir(String lang)Base directory (current working directory) for a conversion. |
|
public Provider<File> |
getBaseDirProvider() |
|
public BaseDirStrategy |
getBaseDirStrategy()Returns the current basedir strategy if it has been configured. |
|
public boolean |
isBaseDirConfigured()Checks whether an explicit strategy has been set for base directory. |
|
public void |
setBaseDir(Object f)Sets the base directory for a conversion. |
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.
Sets the basedir to be the same directory as each individual source file.
Sets the basedir to be the same directory as the current project directory.
Sets the basedir to be the same directory as the root project directory.
Base directory (current working directory) for a conversion.
nullBase 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.
lang - Language in useReturns the current basedir strategy if it has been configured. @{code null}.
Checks whether an explicit strategy has been set for base directory.
true if a strategy has been configured.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.
f - Base directory