AsciidoctorUtils (asciidoctor-gradle-base 4.0.4 API)

org.asciidoctor.gradle.base.AsciidoctorUtils

```
@groovy.transform.CompileStatic
class AsciidoctorUtils
extends Object
```
Utility methods used internally by Asciidoctor plugins.
Authors:
Schalk W. Cronjé
Gary Hale
Since:
2.0.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AsciidoctorUtils.1`

Field Summary

Fields
Modifiers	Name	Description
`static org.ysb33r.grolifant.api.core.OperatingSystem`	`OS`
`static String`	`UNDERSCORE_LED_FILES`
`static PatternSet`	`UNDERSCORE_LED_PATTERN`

Properties Summary

Properties
Type	Name and description
`static Spec<? super File>`	`ACCEPT_ONLY_FILES`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorUtils ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static DirectoryProperty`	`createDirectoryProperty(Project project)` Creates a DirectoryProperty instance in a way that is backwards-comaptible to Gradle 4.3.
	`static void`	`executeDelegatingClosure(Object delegated, groovy.lang.Closure cfg)` Executes a configuration closure.
	`static File`	`getClassLocation(Class aClass)` Returns the location of a class
	`static String`	`getRelativePath(File target, File base)` Returns the path of one File relative to another.
	`static String`	`getRelativePathToFsRoot(File target)` Get relative path to the current filesystem root
	`static FileTree`	`getSourceFileTree(Project project, File sourceDir, PatternSet filePatterns)` Gets a fileTree that described an Asciidoctor set of source files.
	`static FileTree`	`getSourceFileTree(org.ysb33r.grolifant.api.core.ProjectOperations po, File sourceDir, PatternSet filePatterns)` Gets a fileTree that described an Asciidoctor set of source files.
	`static Provider<Directory>`	`mapToDirectoryProvider(Project project, Object value)` Maps a file object to a directory provider
	`static String`	`normalizePath(String path)` Normalises slashes in a path.
	`static void`	`setConvention(Project project, Property<Directory> property, Directory value)` Apply convention in way that is backward-comatible to Gradle 4.3, but utilises features when available in later Gradle releases.
`<T>`	`static void`	`setConvention(Property<T> property, Provider<T> value)` Sets a property convention using a provider in a way that is compatible back to Gradle 4.3.

Inherited Methods Summary

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

- Field Detail
  - public static final org.ysb33r.grolifant.api.core.OperatingSystem OS
  - public static final String UNDERSCORE_LED_FILES
  - public static final PatternSet UNDERSCORE_LED_PATTERN
- Property Detail
  - static final Spec<? super File> ACCEPT_ONLY_FILES
- Constructor Detail
  - AsciidoctorUtils()
- Method Detail
  - static DirectoryProperty createDirectoryProperty(Project project)
    
    Creates a DirectoryProperty instance in a way that is backwards-comaptible to Gradle 4.3.
    Parameters:
    project - Current project context
    Returns:
    DirectoryProperty instance
    Since:
    3.0
  - static void executeDelegatingClosure(Object delegated, groovy.lang.Closure cfg)
    
    Executes a configuration closure. The closure will be cloned before execution.
    Parameters:
    delegated - Closure delegate
    cfg - Closure to execute
  - static File getClassLocation(Class aClass)
    
    Returns the location of a class
    Parameters:
    aClass - Class to look for.
    Returns:
    Location as a file on disk.
  - static String getRelativePath(File target, File base)
    
    Returns the path of one File relative to another.
    throws:
    IOException if an error occurs while resolving the files' canonical names
    
    Parameters:
    target - the target directory
    base - the base directory
    Returns:
    target's path relative to the base directory
  - static String getRelativePathToFsRoot(File target)
    
    Get relative path to the current filesystem root
    Parameters:
    target - The target directory
    Returns:
    taget's pat relative to the filesystem root
    Since:
    3.0
  - @Deprecated static FileTree getSourceFileTree(Project project, File sourceDir, PatternSet filePatterns)
    
    Gets a fileTree that described an Asciidoctor set of source files. @deprecated
    Parameters:
    project - Project to associate the file collection tp.
    sourceDir - Base directory for the sourcs.
    filePatterns - Patterns to use to identify suitable sources.
    Returns:
    A collection of suitable files.
    Throws:
    GradleException is files starting with undersocres are detected.
  - static FileTree getSourceFileTree(org.ysb33r.grolifant.api.core.ProjectOperations po, File sourceDir, PatternSet filePatterns)
    
    Gets a fileTree that described an Asciidoctor set of source files.
    Parameters:
    po - org.ysb33r.grolifant.api.core.ProjectOperations instance to applu
    sourceDir - Base directory for the sourcs.
    filePatterns - Patterns to use to identify suitable sources.
    Returns:
    A collection of suitable files.
    Throws:
    GradleException is files starting with undersocres are detected.
  - static Provider<Directory> mapToDirectoryProvider(Project project, Object value)
    
    Maps a file object to a directory provider
    Parameters:
    project - Project context
    value - Anything convertible with project.file
    Returns:
    Provider of a Directory.
    Since:
    3.0
  - static String normalizePath(String path)
    
    Normalises slashes in a path.
    Parameters:
    path
    Returns:
    Slashes chanegs to backslahes no Windows, unahcnges otherwise.
  - static void setConvention(Project project, Property<Directory> property, Directory value)
    
    Apply convention in way that is backward-comatible to Gradle 4.3, but utilises features when available in later Gradle releases.
    Parameters:
    project - Current project context.
    property - Directory property to which convention should be applied
    value - Default value of directory.
    Since:
    3.0
  - <T> static void setConvention(Property<T> property, Provider<T> value)
    
    Sets a property convention using a provider in a way that is compatible back to Gradle 4.3.
    Parameters:
    property - Property to set
    value - Provider to use
    Since:
    3.0

[Groovy] Class AsciidoctorUtils

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final org.ysb33r.grolifant.api.core.OperatingSystem OS

public static final String UNDERSCORE_LED_FILES

public static final PatternSet UNDERSCORE_LED_PATTERN

Property Detail

static final Spec<? super File> ACCEPT_ONLY_FILES

Constructor Detail

AsciidoctorUtils()

Method Detail

static DirectoryProperty createDirectoryProperty(Project project)

static void executeDelegatingClosure(Object delegated, groovy.lang.Closure cfg)

static File getClassLocation(Class aClass)

static String getRelativePath(File target, File base)

static String getRelativePathToFsRoot(File target)

@Deprecated static FileTree getSourceFileTree(Project project, File sourceDir, PatternSet filePatterns)

static FileTree getSourceFileTree(org.ysb33r.grolifant.api.core.ProjectOperations po, File sourceDir, PatternSet filePatterns)

static Provider<Directory> mapToDirectoryProvider(Project project, Object value)

static String normalizePath(String path)

static void setConvention(Project project, Property<Directory> property, Directory value)

<T> static void setConvention(Property<T> property, Provider<T> value)