DefaultAsciidoctorBaseDirConfiguration (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.internal.DefaultAsciidoctorBaseDirConfiguration

All Implemented Interfaces and Traits:

AsciidoctorTaskBaseDirConfiguration
```
@groovy.transform.CompileStatic
class DefaultAsciidoctorBaseDirConfiguration
extends Object
implements AsciidoctorTaskBaseDirConfiguration
```
The default implementation for base directory copnfiguration.
Authors:
Schalk W. Cronjé
Since:
4.0

Properties Summary

Properties
Type	Name and description
`File`	`baseDir`

Constructor Summary

Constructors
Constructor and description
`DefaultAsciidoctorBaseDirConfiguration (Project project, AsciidoctorTaskFileOperations atfo)`

Methods Summary

Methods
Type Params	Return Type	Name 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.
	`File`	`getBaseDir(String lang)` Base directory (current working directory) for a conversion.
	`Provider<File>`	`getBaseDirProvider()`
	`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(Object f)` Sets the base directory for a conversion.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - File baseDir
- Constructor Detail
  - DefaultAsciidoctorBaseDirConfiguration(Project project, AsciidoctorTaskFileOperations atfo)
- Method Detail
  - @Override 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.
  - @Override void baseDirFollowsSourceFile()
    
    Sets the basedir to be the same directory as each individual source file.
  - @Override void baseDirIsProjectDir()
    
    Sets the basedir to be the same directory as the current project directory.
    Since:
    2.2.0
  - @Override void baseDirIsRootProjectDir()
    
    Sets the basedir to be the same directory as the root project directory.
  - @Override File getBaseDir(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
  - @Override Provider<File> getBaseDirProvider()
  - @Override BaseDirStrategy getBaseDirStrategy()
    
    Returns the current basedir strategy if it has been configured. @{code null}.
    Returns:
    Strategy or
  - @Override boolean isBaseDirConfigured()
    
    Checks whether an explicit strategy has been set for base directory.
    Returns:
    true if a strategy has been configured.
  - @Override void setBaseDir(@Nullable 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 - Can be a BaseDirStrategy, null, or anything convertible to a file.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class DefaultAsciidoctorBaseDirConfiguration

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

File baseDir

Constructor Detail

DefaultAsciidoctorBaseDirConfiguration(Project project, AsciidoctorTaskFileOperations atfo)

Method Detail

@Override void baseDirFollowsSourceDir()

@Override void baseDirFollowsSourceFile()

@Override void baseDirIsProjectDir()

@Override void baseDirIsRootProjectDir()

@Override File getBaseDir(String lang)

@Override Provider<File> getBaseDirProvider()

@Override BaseDirStrategy getBaseDirStrategy()

@Override boolean isBaseDirConfigured()

@Override void setBaseDir(@Nullable Object f)