A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractCacheBinaryTask - Class in org.ysb33r.grolifant.api.v4.wrapper.script
Base class for tasks that cache arbitrary binaries.
AbstractCacheBinaryTask(String) - Constructor in AbstractCacheBinaryTask
Parameters:
locationPropertiesDefaultName - The default name for the location properties file.
AbstractCloudGit - Class in org.ysb33r.grolifant.api.v4.git
Base class for implementing common functionality for GitLab & GitHub
AbstractCloudGit(String, String) - Constructor in AbstractCloudGit
Constructs a representation of a cloud Git provider
AbstractCombinedProjectTaskExtension - Class in org.ysb33r.grolifant.api.v4
Base class for an extension that can both be used on a project or a task.
AbstractCombinedProjectTaskExtension(Task, String) - Constructor in AbstractCombinedProjectTaskExtension
Attach this extension to a task
AbstractCommandExecSpec - Class in org.ysb33r.grolifant.api.v4.exec
Tool execution specification aimed at command-line tools which takes a command as one of the arguments.
AbstractCommandExecSpec(ProjectOperations, ExternalExecutable) - Constructor in AbstractCommandExecSpec
Construct class and attach it to specific project.
AbstractCommandExecTask - Class in org.ysb33r.grolifant.api.v4.exec
A abstract task type for executing binaries that take a command as well as a set of command arguments.
AbstractDistributionInstaller - Class in org.ysb33r.grolifant.api.v4.downloader
Common functionality to be able to download a SDK and use it within Gradle
AbstractDistributionInstaller(String, String, ProjectOperations) - Constructor in AbstractDistributionInstaller
Creates setup for installing to a local cache.
AbstractExecSpec - Class in org.ysb33r.grolifant.api.v4.exec
Abstract base class that implements BaseExecSpec.
AbstractExecSpec(ProjectOperations) - Constructor in AbstractExecSpec
AbstractExecWrapperTask - Class in org.ysb33r.grolifant.api.v4.exec
Base task class to wrap external tool executions without exposing command-line parameters directly.
AbstractExecWrapperTask() - Constructor in AbstractExecWrapperTask
AbstractExecWrapperWithExtensionTask - Class in org.ysb33r.grolifant.api.v4.runnable
@param
AbstractExecWrapperWithExtensionTask() - Constructor in AbstractExecWrapperWithExtensionTask
AbstractScriptExecSpec - Class in org.ysb33r.grolifant.api.v4.exec
Tool execution specification aimed at script-line tools which takes a script as one of the arguments.
AbstractScriptExecSpec(ProjectOperations, ExternalExecutable) - Constructor in AbstractScriptExecSpec
Construct class and attach it to specific project.
AbstractScriptExecTask - Class in org.ysb33r.grolifant.api.v4.exec
A abstract task type for executing binaries that take a command as well as a set of command arguments.
AbstractScriptWrapperTask - Class in org.ysb33r.grolifant.api.v4.wrapper.script
An abstract base class for creating tasks that create script wrappers.
AbstractScriptWrapperTask() - Constructor in AbstractScriptWrapperTask
AbstractSingleFileInstaller - Class in org.ysb33r.grolifant.api.v4.downloader
AbstractToolExecSpec - Class in org.ysb33r.grolifant.api.v4.exec
A base class to aid plugin developers create their own ExecSpec implementations.
AbstractToolExecSpec(ProjectOperations, ExternalExecutable) - Constructor in AbstractToolExecSpec
Construct class and attach it to specific project.
AbstractToolExtension - Class in org.ysb33r.grolifant.api.v4.runnable
Use as a base class for extensions that will wrap tools.
AbstractToolExtension(Task, ProjectOperations, T) - Constructor in AbstractToolExtension
Attach this extension to a task
addEnvironmentToExecSpec(T) - Method in AbstractExecWrapperTask
Adds the configured environment to the execution specification.
addExecPattern(String) - Method in AbstractDistributionInstaller
Add patterns for files to be marked exe,
addExecProjectExtension(String, ProjectOperations, ExecSpecInstantiator<? extends AbstractToolExecSpec>) - Method in ExtensionUtils
Adds a project extension so that specific tools can be execute in a similar manner to Project.exec.
addExecutableToExecSpec(T) - Method in AbstractExecWrapperTask
Adds the exe to the execution specification.
ArtifactDownloader - Class in org.ysb33r.grolifant.api.v4.downloader
Performs low-level downloading work.
ArtifactDownloader(URI, File, File, String, ArtifactRequiresDownload, CheckSumVerification) - Constructor in ArtifactDownloader
Download an artifact without unpacking it.
ArtifactRequiresDownload - Interface in org.ysb33r.grolifant.api.v4.downloader
Indicates whether download is required.
ArtifactRootVerification - Interface in org.ysb33r.grolifant.api.v4.downloader
Verifies an artifact root
ArtifactUnpacker - Interface in org.ysb33r.grolifant.api.v4.downloader
Unpacks an artifact.
asConfiguration(Project, Object) - Method in ConfigurationUtils
Tries to resolve a configuration from the provided object.
asConfigurations(Project, Iterable<?>) - Method in ConfigurationUtils
Converts a collection of items to configurations.
authentication(Action<? super AuthenticationContainer>) - Method in AuthenticationSupportedRepository
AuthenticationSupportedRepository - Class in org.ysb33r.grolifant.api.v4.repositories
Base class for creating repository types that optionally support authentication.
AuthenticationSupportedRepository(Project) - Constructor in AuthenticationSupportedRepository
Base class constructor
AuthenticationSupportedRepositoryContent - Interface in org.ysb33r.grolifant.api.v4.repositories
Configures content for an authentication-supported repository.

B

bindDependencyHandlerService(Project, String, Class) - Method in ExtensionUtils
Binds a new extension handler on to the project dependency handler.
bindRepositoryHandlerService(Project, String, Class) - Method in ExtensionUtils
Binds a new extension handler on to the project repository handler.
bindService(Object, String, Object) - Method in ExtensionUtils
Binds a service object to the extensions object on an existing Gradle DSL Object
bootstrapClasspath(Object) - Method in JavaForkOptions
Adds the given values to the end of the bootstrap classpath for the process.
build(Map<String, Object>, Object) - Method in ResolvedExecutableFactory
Creates ResolvableExecutable from a specific input.
build(Map<String, Object>, Object) - Method in ResolveExecutableByVersion
Creates ResolvableExecutable from a tool version.
buildCommandLine() - Method in AbstractToolExecSpec
Builds up the command line.

C

ClosureUtils - Class in org.ysb33r.grolifant.api.v4
Methods for dealing with closures
CloudGitConfigurator - Interface in org.ysb33r.grolifant.api.v4.git
A description of a Git repository from a cloud provider
CloudGitDescriptor - Interface in org.ysb33r.grolifant.api.v4.git
A description of a Git repository from a cloud provider
cmdArgs(Object) - Method in AbstractCommandExecSpec
Add more command-specific arguments.
cmdArgs(Object) - Method in AbstractCommandExecTask
Add more command-specific arguments.
CombinedProjectTaskExtensionBase - Class in org.ysb33r.grolifant.api.v4
Base class for an extension that can both be used on a project or a task.
CombinedProjectTaskExtensionBase(Task, ProjectOperations, T) - Constructor in CombinedProjectTaskExtensionBase
Attach this extension to a task
command(Object) - Method in AbstractCommandExecSpec
Set the command to use.
command(Object) - Method in AbstractCommandExecTask
Set the command to use.
ConfigurationUtils - Class in org.ysb33r.grolifant.api.v4
Utilities to deal with Configuration instances.
configure(Closure) - Method in AbstractToolExecSpec
Configure this spec from a closure.
configure(Closure) - Method in TaskProvider
Configures that the task this task provider proxy points to.
configure(Action<? extends ToolExecSpec>) - Method in ToolExecSpec
Configure this spec from an Action
configure(Closure) - Method in ToolExecSpecGroovy
Configure this spec from a closure.
configureByName(TaskContainer, String, Closure) - Method in TaskProvider
Configures a task by name.
configureEach(TaskContainer, Class, Action<? super Task>) - Method in TaskProvider
Configures each task of a specific type.
configureExecSpec() - Method in AbstractCommandExecTask
Configures the executions specification from settings.
configureExecSpec(T) - Method in AbstractExecWrapperTask
Configures an execution specification from task properties
configureExecSpec() - Method in AbstractScriptExecTask
Configures the executions specification from settings.
configureItem(Object, Closure) - Method in ClosureUtils
Configure this item using a closure
content(Action) - Method in AuthenticationSupportedRepository
This is currently a NOOP.
CopyExecSpec - Interface in org.ysb33r.grolifant.api.v4.runnable
Indicates that a class can copy settings to a standard ExecSpec.
copyTo(ProcessForkOptions) - Method in AbstractToolExecSpec
Copies options from this Spec to the given target.
copyTo(ProcessForkOptions) - Method in JavaForkOptions
Copies these options to the given target options.
copyToExecSpec(ExecSpec) - Method in AbstractToolExecSpec
Copies settings from this execution specification to a standard ExecSpec
copyToExecSpec(ExecSpec) - Method in CopyExecSpec
Copies settings from this execution specification to a standard ExecSpec
create(Map<String, Object>, String, ProjectOperations) - Method in DownloaderFactory
Creates a downloader
create(Map<String, Object>, String, Project) - Method in ResolveExecutableByVersion.DownloaderFactory
Creates a downloader
createExecSpec() - Method in AbstractExecWrapperTask
Creates a new execution specification.
credentials(Class<? extends Credentials>) - Method in AuthenticationSupportedRepository
Implements the repository method added in Gradle 6.6.

D

DependencyCache - Class in org.ysb33r.grolifant.api.v4.artifacts
A custom implementation of a dependency cache when the one from Gradle might not be directly accessible.
DependencyCache.CacheRefresh - Interface in org.ysb33r.grolifant.api.v4.artifacts
DependencyCache.PostDownloadProcessor - Interface in org.ysb33r.grolifant.api.v4.artifacts
DependencyCache(Project, String, String, DependencyCache.CacheRefresh, CheckSumVerification, DependencyCache.PostDownloadProcessor) - Constructor in DependencyCache
Parameters:
project - Project context.
DistributionInstaller - Interface in org.ysb33r.grolifant.api.v4.downloader
Interface for a downloader and unpacker of distributions.
distributionName - Field in AbstractDistributionInstaller
Name of the distribution.
DownloadedExecutable - Interface in org.ysb33r.grolifant.api.v4.exec
Resolves the executable within a downloaded package.
DownloaderFactory - Interface in org.ysb33r.grolifant.api.v4.exec
A factory for creating tool/distribution downloaders.

E

env - Field in AbstractExecSpec
environment(String, Object) - Method in AbstractExecSpec
Add additional environment variable for use with the process.
environment(Map<String, ?>) - Method in AbstractExecWrapperTask
Add environmental variables to be passed to the exe.
environment(String, Object) - Method in JavaForkOptions
Adds an environment variable to the environment for this process.
errorOutput(OutputStream) - Method in AbstractExecSpec
Set the stream where error output should be sent to for this process when executing.
errorOutput(OutputStream) - Method in MutableBaseExecSpec
Set the stream where error output should be sent to for this process when executing.
exeArgs(Object) - Method in AbstractToolExecSpec
Add more tool-specific arguments.
exeArgs(Object) - Method in MutableToolExecSpec
Add more tool-specific arguments.
exec() - Method in AbstractCacheBinaryTask
exec() - Method in AbstractExecWrapperTask
The default implementation will build an execution specification and run it.
exec(E) - Method in ExecMethods
Executes an existing execution specification.
ExecMethods - Interface in org.ysb33r.grolifant.api.v4.runnable
Adds interface to a AbstractToolExtension implementation, so that the spirit of the original exec project extension can be maintained for a specific tool.
executable(Map<String, Object>) - Method in AbstractToolExecSpec
Use a key-value approach to setting the exe.
executable(Map<String, ?>) - Method in AbstractToolExtension
Set the parameters for locating an exe.
executable(Object) - Method in JavaForkOptions
Sets the name of the exe to use.
executable(ResolvableExecutable) - Method in MutableToolExecSpec
Set the exe to use.
executableByPath(Object) - Method in AbstractToolExtension
Locate an executable by a local path.
executableBySearchPath(Object) - Method in AbstractToolExtension
Locate executable by searching the current environmental search path.
executableByVersion(Object) - Method in AbstractToolExtension
Locate an executable by version, probably downloading it if not local.
ExecutableCommandExecSpec - Interface in org.ysb33r.grolifant.api.v4.runnable
Interface that specifies an execution specification for an executable that is command-based.
ExecutableDownloader - Interface in org.ysb33r.grolifant.api.v4.runnable
Interface for downloading an executable by version and returning the location.
ExecutableExecSpec - Interface in org.ysb33r.grolifant.api.v4.runnable
@param The class that extends this interface
executablePathOrNull() - Method in AbstractToolExtension
If a path has been set instead of a version, resolve the path.
ExecutableScriptExecSpec - Interface in org.ysb33r.grolifant.api.v4.runnable
executableSearchPathOrNull() - Method in AbstractToolExtension
If a search path has been set, resolve the location by searching path
executableVersionOrNull() - Method in AbstractToolExtension
Resolves the version if it has been set.
ExecUtils - Class in org.ysb33r.grolifant.api.v4.runnable
Utilities to help with building runnable classes.
ExtensionUtils - Class in org.ysb33r.grolifant.api.v4
Utilities to deal with Gradle extensions and project extensions
ExternalExecutable - Interface in org.ysb33r.grolifant.api.v4.exec
A way to create a lazy-evaluated location of an external executable.
ExternalExecutableType - Interface in org.ysb33r.grolifant.api.v4.exec
A way to create a lazy-evaluated parameters of an external executable.

F

fileize(Project, Iterable<Object>) - Method in FileUtils
Converts a collection of file-like objects to a a list of File instances with project context.
fileizeDropNull(Project, Iterable<Object>) - Method in FileUtils
Converts a collection of file-like objects to a a list of File instances with project context.
fileizeOrNull(Project, Object) - Method in FileUtils
Converts a file-like object to a File instance with project context.
filesFromCopySpec(CopySpec) - Method in FileUtils
Returns the file collection that a CopySpec describes.
FileUtils - Class in org.ysb33r.grolifant.api.v4
Various file utilities.
findValidKey(Map<String, Object>) - Method in ResolverFactoryRegistry
Look for exactly one valid key in the supplied map.
FreeBSD - Class in org.ysb33r.grolifant.api.v4.os
FreeBSD implementation of OperatingSystem.

G

GenericBSD - Class in org.ysb33r.grolifant.api.v4.os
Abstract base class for BSD-based operating systems.
GenericBSD() - Constructor in GenericBSD
GenericUnix - Class in org.ysb33r.grolifant.api.v4.os
Generic Unix-like implementation of OperatingSystem.
GenericUnix() - Constructor in GenericUnix
get() - Method in TaskProvider
Resolves the task
getAdditionalProperties() - Method in AbstractCacheBinaryTask
Returns additional properties to be added to the cached binary properties file.
getAndVerifyDistributionRoot(File, String) - Method in AbstractDistributionInstaller
Validates that the unpacked distribution is good.
getArch() - Method in GenericUnix
Architecture underlying the operating system
getArch() - Method in Windows
Architecture underlying the operating system
getArchivePath() - Method in AbstractCloudGit
Calculates an archive path for the specific repository type.
getArchivePath() - Method in GitHubArchive
Calculates an archive path for the specific repository type.
getArchivePath() - Method in GitLabArchive
Calculates an archive path for the specific repository type.
getArchiveRoot() - Method in GitRepoArchiveDownloader
Returns the location which is the top or home folder for a distribution.
getArchiveUri() - Method in AbstractCloudGit
Obtains the URI for the archive of the repository.
getArchStr() - Method in GenericUnix
Implementation-specific free-form architecture string.
getArchStr() - Method in Solaris
Solaris-specific architecture strings.
getArchStr() - Method in Windows
Architecture underlying the operating system
getAuthentication() - Method in AuthenticationSupportedRepository
getBinaryLocation() - Method in AbstractCacheBinaryTask
Obtains location of executable binary or script
getBinaryVersion() - Method in AbstractCacheBinaryTask
Obtains version of binary or script
getBootstrapClasspath() - Method in JavaForkOptions
Returns the bootstrap classpath to use for the process.
getCachedBinaryProperties() - Method in AbstractCacheBinaryTask
getCmdArgs() - Method in AbstractCommandExecSpec
Any arguments specific to the command.
getCmdArgs() - Method in AbstractCommandExecTask
Any arguments specific to the command in use
getCommand() - Method in AbstractCommandExecSpec
The script used in this specification as a String.
getCommand() - Method in AbstractCommandExecTask
The command used in this specification as a String.
getCommandLine() - Method in AbstractToolExecSpec
Returns the full script line, including the exe, it's specific arguments, tool specific instruction and the arguments specific to the instruction.
getCredentials(Class<T>) - Method in AuthenticationSupportedRepository
getDebug() - Method in JavaForkOptions
Returns true if debugging is enabled for the process.
getDefaultCharacterEncoding() - Method in JavaForkOptions
Returns the default character encoding to use.
getDistFromCache(String) - Method in AbstractDistributionInstaller
Creates a distribution if it does not exist already.
getDistFromSdkMan(String) - Method in AbstractDistributionInstaller
Attempts to locate distribution in the list of SdkMan candidates.
getDistributionFile(String, String) - Method in AbstractDistributionInstaller
Locates a file within the distribution
getDistributionRoot(String) - Method in AbstractDistributionInstaller
Returns the location which is the top or home folder for a distribution.
getDownloader() - Method in AbstractToolExtension
Gets the downloader implementation.
getEnableAssertions() - Method in JavaForkOptions
Returns true if assertions are enabled for the process.
getEnvironment() - Method in AbstractExecSpec
Returns the environment to be used for the process.
getEnvironment() - Method in AbstractExecWrapperTask
Environment for running the exe
getEnvironment() - Method in JavaForkOptions
The environment variables to use for the process.
getErrorOutput() - Method in AbstractExecSpec
Where error output is sent to during execution.
getExeArgs() - Method in AbstractToolExecSpec
Any arguments specific to the tool in use
getExeArgs() - Method in MutableToolExecSpec
Any arguments specific to the tool in use
getExecutable() - Method in AbstractToolExecSpec
The exe used in this specification as a String.
getExecutable() - Method in AbstractToolExtension
A provider for a resolved executable.
getExecutable() - Method in JavaForkOptions
Returns the name of the exe to use.
getExecutable() - Method in ResolvableExecutable
Location of a tool exe.
getExecutableName(String) - Method in GenericUnix
Given a base string, returns the Unix exe name.
getExecutableName(String) - Method in Windows
getExecutableNames(String) - Method in GenericUnix
Given a base string, returns the Unix exe name.
getExecutableNames(String) - Method in Windows
getExecutableResolver() - Method in AbstractToolExecSpec
Access to the object that can resolve exe location from property maps.
getFromCache(String, boolean, Downloader) - Method in ArtifactDownloader
Creates a distribution/file it it does not exist already.
getFromCache(URI, String, String) - Method in DependencyCache
Extract an artifact from cache.
getIdentifier() - Method in AbstractCloudGit
Returns an identifier of an instance in the repository.
getInstructionsArgs() - Method in AbstractToolExecSpec
List of arguments specific to the tool instruction.
getJvmArgs() - Method in JavaForkOptions
Returns the extra arguments to use to launch the JVM for the process.
getLocationPropertiesFile() - Method in AbstractCacheBinaryTask
getLogger() - Method in AbstractDistributionInstaller
Returns the logger currently in use.
getMaxHeapSize() - Method in JavaForkOptions
Returns the maximum heap size for the process, if any.
getMinHeapSize() - Method in JavaForkOptions
Returns the minimum heap size for the process, if any.
getName() - Method in AbstractCloudGit
Obtains the name of the Git service.
getName() - Method in NamedResolvedExecutableFactory
Returns a name that can be used as a key into a ResolverFactoryRegistry.
getName() - Method in TaskProvider
The name of the task this task provider proxy is associated with.
getOrganisation() - Method in AbstractCloudGit
Get the organisation
getPath(T) - Method in DownloadedExecutable
Given a downloader resolve the path to the exe.
getPkgName(URI) - Method in UriUtils
Get final package or directory name from a URI
getProject() - Method in AbstractCombinedProjectTaskExtension
Project this extension is associated with.
getProject() - Method in AbstractDistributionInstaller
Returns the attached project
getProject() - Method in AbstractExecSpec
@return Project if items was created in legacy mode, otherwise null.
getProjectExtension() - Method in AbstractCombinedProjectTaskExtension
Returns the extension that is attached to the project.
getProjectExtension() - Method in CombinedProjectTaskExtensionBase
If this extension is attached to a task, this point to the global project extension if it exists, other null.
getProjectExtensions() - Method in AbstractCombinedProjectTaskExtension
Returns the project's extension container, but safe in configuration cache context.
getProjectOperations() - Method in AbstractCombinedProjectTaskExtension
Returns a instance of org.ysb33r.grolifant.api.core.ProjectOperations.
getProjectOperations() - Method in AbstractExecSpec
@return org.ysb33r.grolifant.api.core.ProjectOperations
getPropertiesDescription() - Method in AbstractCacheBinaryTask
Obtains a description to be added to the cached binary properties file.
getRepository() - Method in AbstractCloudGit
Get the repository
getResolvableExecutable() - Method in AbstractToolExecSpec
Lazy-evaluated version of the exe
getResolvableExecutable() - Method in AbstractToolExtension
Obtain a lazy-evaluated object to resolve a path to an exe.
getResolvableExecutable(Map<String, Object>) - Method in ExternalExecutable
Lazy-evaluated version of the exe
getResolvableExecutable() - Method in MutableToolExecSpec
Lazy-evaluated version of the exe
getResolvableExecutable(Map<String, Object>) - Method in ResolverFactoryRegistry
Use a key-value approach to finding the exe.
getResolvableExecutableType() - Method in AbstractToolExtension
Describes the parameters for resolving the executable.
getResolvableExecutableType(Map<String, Object>) - Method in ExternalExecutableType
Lazy-evaluated description of the exe
getResolvableExecutableType(Map<String, Object>) - Method in ResolverFactoryRegistry
Lazy-evaluated description of the exe
getResolver() - Method in AbstractToolExtension
Get access to object that can resolve an executable's location from a property map.
getResolverFactoryRegistry() - Method in AbstractToolExtension
Access to the registry of exe resolver factories.
getScript() - Method in AbstractScriptExecSpec
The script used in this specification as a String.
getScript() - Method in AbstractScriptExecTask
The script used in this specification as a String.
getScriptArgs() - Method in AbstractScriptExecSpec
Any arguments specific to the script.
getScriptArgs() - Method in AbstractScriptExecTask
Any arguments specific to the script in use
getScriptName(String) - Method in GenericUnix
Returns OS-specific decorated script name.
getScriptName(String) - Method in Windows
Returns Windows-specific decorated script name.
getSdkManCandidateName() - Method in AbstractDistributionInstaller
SDKman candidate name for distribution.
getSharedLibraryName(String) - Method in GenericUnix
Returns OS-specific shared library name
getSharedLibraryName(String) - Method in Windows
Returns Windows shared library name
getSharedLibrarySuffix() - Method in GenericUnix
Return Unix-like string that is used to suffix to shared libraries
getSharedLibrarySuffix() - Method in MacOsX
Return MacOSX string that is used to suffix to shared libraries
getSingleFile(String) - Method in AbstractSingleFileInstaller
Returns the path to the terraform executable.
getSingleFileName() - Method in AbstractSingleFileInstaller
Gets the name of the single file as it should be on local disk
getStandardInput() - Method in AbstractExecSpec
Where input is read from during execution.
getStandardOutput() - Method in AbstractExecSpec
Where standard output is sent to during execution.
getStaticLibraryName(String) - Method in GenericUnix
Returns OS-specific static library name
getStaticLibraryName(String) - Method in Windows
Returns OS-specific static library name
getSystemProperties() - Method in JavaForkOptions
Returns the system properties which will be used for the process.
getTask() - Method in AbstractCombinedProjectTaskExtension
Task this extension is attached to.
getTask() - Method in CombinedProjectTaskExtensionBase
Task this extension is attached to.
getToolExecSpec() - Method in AbstractCommandExecTask
Execution specification customised for the specific tool
getToolExtension() - Method in AbstractExecWrapperTask
Returns the extension that is associated with the specific tool
getToolExtension() - Method in AbstractExecWrapperWithExtensionTask
Access to the task extension of the tool type.
getToolInstruction() - Method in AbstractCommandExecSpec
A specific instruction passed to a tool.
getToolInstruction() - Method in AbstractScriptExecSpec
A specific instruction passed to a tool.
getToolInstruction() - Method in AbstractToolExecSpec
A specific instruction passed to a tool.
getType() - Method in ResolvableExecutableType
A textual name of the type of executable resolver.
getTypeResolver() - Method in AbstractToolExtension
Get access to object that can resolve an executable's location type from a property map
getValue(Closure) - Method in AbstractCombinedProjectTaskExtension
Uses a closure to resolve a value on a project extension or a task extension.
getValue() - Method in ResolvableExecutableType
Provided value for resolving an executable.
getValueByMethod(String) - Method in AbstractCombinedProjectTaskExtension
Uses reflection to invoke a method on a project extension or a task extension.
getWindowsExtensionSearchOrder() - Method in AbstractToolExtension
The order in which extensions will be checked for locating an executable on Windows.
getWorkingDir() - Method in AbstractExecSpec
Obtain the working directory for this process.
getWorkingDir() - Method in JavaForkOptions
Returns the working directory for the process.
getWrapperDestinationDir() - Method in AbstractScriptWrapperTask
Directory for writing wrapper files to.
GitHubArchive - Class in org.ysb33r.grolifant.api.v4.git
Describes a GitHub archive.
GitHubArchive() - Constructor in GitHubArchive
GitLabArchive - Class in org.ysb33r.grolifant.api.v4.git
Describes a GitLab archive.
GitLabArchive() - Constructor in GitLabArchive
GitRepoArchiveDownloader - Class in org.ysb33r.grolifant.api.v4.git
Downloads an archive of a Git repository.
GitRepoArchiveDownloader(CloudGitDescriptor, Project) - Constructor in GitRepoArchiveDownloader

H

hasCredentials() - Method in AuthenticationSupportedRepository
Check is any credentials has been accessed.
hashURI(URI) - Method in UriUtils
Creates a SHA-256 has of a URI.

I

ignoreExitValue(boolean) - Method in AbstractExecSpec
Determine whether the exit value should be ignored.
ignoreExitValue(boolean) - Method in MutableBaseExecSpec
Determine whether the exit value should be ignored.
INSTANCE - Field in Windows
instructionArgs(Object) - Method in AbstractToolExecSpec
Add more instruction-specific arguments.
IS_WINDOWS - Field in AbstractDistributionInstaller
isFreeBSD() - Method in FreeBSD
isIgnoreExitValue() - Method in AbstractExecSpec
State of exit value monitoring.
isLinux() - Method in Linux
Confirms that this is an OS representation of a Linux operating system.
isMacOsX() - Method in MacOsX
Confirms that this is an OS representation of a Mac operating system.
isNetBSD() - Method in NetBSD
Confirms that this is an OS representation NetBSD.
isSolaris() - Method in Solaris
Confirms this is a representation of the Solaris operating system.
isUnix() - Method in GenericUnix
Confirms that this is a Unix-like operating system.
isWindows() - Method in Windows
Confirms this is a representation of the Microsoft Windows operating system.

J

JavaForkOptions - Class in org.ysb33r.grolifant.api.v4
Provides a class that can be populated with various fork options for Java and which can then be used to copy to other methods in the Gradle API that provides a JavaForkOptions in the parameters.
jvmArgs(Object) - Method in JavaForkOptions
Adds some arguments to use to launch the JVM for the process.
JvmScriptSpec - Interface in org.ysb33r.grolifant.api.v4.runnable
Defines a script specificaition that will be executed on the JVM

K

L

Linux - Class in org.ysb33r.grolifant.api.v4.os
Linux implementation of OperatingSystem.
listDirs(File) - Method in AbstractDistributionInstaller
Provides a list of directories below an unpacked distribution
listDirs(File) - Method in FileUtils
Provides a list of directories below another directory
locateDistributionInCustomLocation(String) - Method in AbstractDistributionInstaller
Override this method to provide alternative means to look for distributions.

M

MacOsX - Class in org.ysb33r.grolifant.api.v4.os
MacOSX implementation of OperatingSystem.
MapUtils - Class in org.ysb33r.grolifant.api.v4
Various utilities dealing with key-value pairs.
MutableBaseExecSpec - Interface in org.ysb33r.grolifant.api.v4.exec
MutableToolExecSpec - Interface in org.ysb33r.grolifant.api.v4.exec
Methods for setting executables and arguments.

N

NamedResolvedExecutableFactory - Interface in org.ysb33r.grolifant.api.v4.exec
Provides a fixed name usable as a key.
NetBSD - Class in org.ysb33r.grolifant.api.v4.os
NetBSD implementation of OperatingSystem.

O

P

parseVersionFromOutput(ProjectOperations, Iterable<String>, File, Function<String, String>, Action<ExecSpec>) - Method in ExecUtils
Simplifies running an executable to obtain a version.
PROJECT_SYSTEM_ENV - Field in PropertyResolver
projectCacheDirFor(Project) - Method in FileUtils
Returns the project cache directory for the given project.
projectOperations - Field in AbstractDistributionInstaller
Project operations that can used during downloading.
projectOperations - Field in AbstractExecWrapperTask
org.ysb33r.grolifant.api.core.ProjectOperations instance that can be utilised within the task hierarchy
PropertyResolveOrder - Interface in org.ysb33r.grolifant.api.v4
Resolves a property within a certain order
PropertyResolver - Class in org.ysb33r.grolifant.api.v4
Resolves properties in a certain i.e. like SpringBoot, but less functionality to suite Gradle context.

Q

R

registerExecutableKeyActions(NamedResolvedExecutableFactory) - Method in ResolverFactoryRegistry
Register more ways of locating executables.
registerTask(TaskContainer, String, Class<T>, Object) - Method in TaskProvider
Depending on the version of Gradle creates or registers a new task.
ResolvableExecutable - Interface in org.ysb33r.grolifant.api.v4.exec
Holds a reference to an exe that will only be made available when explicitly called.
ResolvableExecutableType - Interface in org.ysb33r.grolifant.api.v4.exec
Authors:
Schalk W.
resolveClassLocation(Class) - Method in FileUtils
Returns the classpath location for a specific class
ResolvedExecutableFactory - Interface in org.ysb33r.grolifant.api.v4.exec
resolvedExecutableVersion() - Method in AbstractToolExtension
If configured by version returns that, otherwise it might run the executable to obtain the version.
resolveDistributionLocationForVersion(String) - Method in AbstractDistributionInstaller
Resolves distribution location by looking in various locations.
ResolveExecutableByVersion - Class in org.ysb33r.grolifant.api.v4.exec
Uses an implementation of an AbstractDistributionInstaller to find an exe by version number.
ResolveExecutableByVersion.DownloadedExecutable - Interface in org.ysb33r.grolifant.api.v4.exec
@param An implementation of an AbstractDistributionInstaller
ResolveExecutableByVersion.DownloaderFactory - Interface in org.ysb33r.grolifant.api.v4.exec
@param An implementation of an AbstractDistributionInstaller
ResolveExecutableByVersion(ProjectOperations, DownloaderFactory, DownloadedExecutable) - Constructor in ResolveExecutableByVersion
Resolve by downloadable version.
ResolverFactoryRegistry - Class in org.ysb33r.grolifant.api.v4.exec
A registry of factories for locating executables.
ResolverFactoryRegistry(ProjectOperations) - Constructor in ResolverFactoryRegistry
Create a registry of factories for locating executables
runExecSpec(T) - Method in AbstractExecWrapperTask
runExecutableAndReturnVersion() - Method in AbstractToolExtension
Runs the executable and returns the version.

S

SAFE_FILENAME_REGEX - Field in FileUtils
safeUri(URI) - Method in UriUtils
Create a URI where the user/password is masked out.
script(Object) - Method in AbstractScriptExecSpec
Set the exe to use.
script(Object) - Method in AbstractScriptExecTask
Set the script to use.
scriptArgs(Object) - Method in AbstractScriptExecSpec
Add more script-specific arguments.
scriptArgs(Object) - Method in AbstractScriptExecTask
Add more script-specific arguments.
setBootstrapClasspath(FileCollection) - Method in JavaForkOptions
Sets the bootstrap classpath to use for the process.
setBranch(Object) - Method in AbstractCloudGit
Set the branch.
setChecksum(String) - Method in AbstractDistributionInstaller
Set a checksum that needs to be verified against downloaded archive
setCmdArgs(Iterable<?>) - Method in AbstractCommandExecSpec
Replace the command-specific arguments with a new set.
setCmdArgs(Iterable<?>) - Method in AbstractCommandExecTask
Replace the command-specific arguments with a new set.
setCommand(Object) - Method in AbstractCommandExecSpec
Set the command to use.
setCommand(Object) - Method in AbstractCommandExecTask
Set the command to use.
setCommit(Object) - Method in AbstractCloudGit
Set the commit to use.
setDebug(boolean) - Method in JavaForkOptions
Enable or disable debugging for the process.
setDefaultCharacterEncoding(String) - Method in JavaForkOptions
Sets the default character encoding to use.
setDownloadRoot(Object) - Method in AbstractDistributionInstaller
Sets a download root directory for the distribution.
setDownloadRoot(File) - Method in DependencyCache
Sets a root directory for the cache.
setDownloadRoot(File) - Method in GitRepoArchiveDownloader
Sets a download root directory for the distribution.
setEnableAssertions(boolean) - Method in JavaForkOptions
Enable or disable assertions for the process.
setEnvironment(Map<String, ?>) - Method in AbstractExecSpec
Set the environment variables to use for the process.
setEnvironment(Map<String, ?>) - Method in AbstractExecWrapperTask
Replace current environment with new one.
setEnvironment(Map<String, ?>) - Method in JavaForkOptions
Sets the environment variable to use for the process.
setErrorOutput(OutputStream) - Method in AbstractExecSpec
Set the stream where error output should be sent to for this process when executing.
setExeArgs(Iterable<?>) - Method in AbstractToolExecSpec
Replace the tool-specific arguments with a new set.
setExeArgs(Iterable<?>) - Method in MutableToolExecSpec
Replace the tool-specific arguments with a new set.
setExecutable(Map<String, Object>) - Method in AbstractToolExecSpec
Use a key-value approach to setting the exe.
setExecutable(Object) - Method in JavaForkOptions
Sets the name of the exe to use.
setExecutable(ResolvableExecutable) - Method in MutableToolExecSpec
Set the exe to use.
setIgnoreExitValue(boolean) - Method in AbstractExecSpec
setInstructionArgs(Iterable<?>) - Method in AbstractToolExecSpec
Replace the instruction-specific arguments with a new set.
setJvmArgs(Iterable<?>) - Method in JavaForkOptions
Sets the extra arguments to use to launch the JVM for the process.
setLocationPropertiesFile(Object) - Method in AbstractCacheBinaryTask
setMaxHeapSize(String) - Method in JavaForkOptions
Sets the maximum heap size for the process.
setMinHeapSize(String) - Method in JavaForkOptions
Sets the minimum heap size for the process.
setOrganisation(Object) - Method in AbstractCloudGit
Set the organisation.
setRepository(Object) - Method in AbstractCloudGit
Set the repository
setScript(Object) - Method in AbstractScriptExecSpec
Set the exe to use.
setScript(Object) - Method in AbstractScriptExecTask
Set the script to use.
setScriptArgs(Iterable<?>) - Method in AbstractScriptExecSpec
Replace the script-specific arguments with a new set.
setScriptArgs(Iterable<?>) - Method in AbstractScriptExecTask
Replace the script-specific arguments with a new set.
setSdkManCandidateName(String) - Method in AbstractDistributionInstaller
Set candidate name for SdkMan if the latter should be searched for installed versions
setStandardInput(InputStream) - Method in AbstractExecSpec
Set the stream where standard input should be read from for this process when executing.
setStandardOutput(OutputStream) - Method in AbstractExecSpec
Set the stream where standard output should be sent to for this process when executing.
setSystemProperties(Map<String, ?>) - Method in JavaForkOptions
Sets the system properties to use for the process.
setTag(Object) - Method in AbstractCloudGit
Set the tag.
setWindowsExtensionSearchOrder(String) - Method in AbstractToolExtension
setWorkingDir(File) - Method in AbstractExecSpec
Set the working directory for the execution.
setWorkingDir(Object) - Method in JavaForkOptions
Sets the working directory for the process.
setWorkingDir(File) - Method in MutableBaseExecSpec
Set the working directory for the execution.
SimplePasswordCredentials - Class in org.ysb33r.grolifant.api.v4.repositories
Simple memory-based implementation of password credentials.
Solaris - Class in org.ysb33r.grolifant.api.v4.os
standardInput(InputStream) - Method in AbstractExecSpec
Set the stream where standard input should be read from for this process when executing.
standardInput(InputStream) - Method in MutableBaseExecSpec
Set the stream where standard input should be read from for this process when executing.
standardOutput(OutputStream) - Method in AbstractExecSpec
Set the stream where standard output should be sent to for this process when executing.
standardOutput(OutputStream) - Method in MutableBaseExecSpec
Set the stream where standard output should be sent to for this process when executing.
stringizeValues(Map<String, Object>) - Method in MapUtils
Evaluates a map of objects to a map of strings.
SYSTEM_ENV_PROPERTY - Field in PropertyResolver
systemProperties(Map<String, ?>) - Method in JavaForkOptions
Adds some system properties to use for the process.
systemProperty(String, Object) - Method in JavaForkOptions
Adds a system property to use for the process.

T

taskByName(TaskContainer, String) - Method in TaskProvider
Finds a task on the given project by name
taskByTypeAndName(TaskContainer, Class, String) - Method in TaskProvider
Finds a task by both type and name
taskize(Project, Iterable<Object>) - Method in TaskUtils
Resolves a list of items to a list of tasks.
TaskProvider - Class in org.ysb33r.grolifant.api.v4
Utilities dealing with the creating of tasks allowing for lazy creation of tasks on Gradle 4.9+, but still use the standard Gradle TaskContainer.create API methods for earlier versions.
TaskProvider(Object) - Constructor in TaskProvider
taskProviderFrom(Project, Object) - Method in TaskUtils
Creates a basic task Provider instance from an object.
TaskUtils - Class in org.ysb33r.grolifant.api.v4
Utilities for dealing with tasks.
ToolExecSpec - Interface in org.ysb33r.grolifant.api.v4.exec
Specified ways of configuring an execution specification for an external tool.
ToolExecSpecGroovy - Interface in org.ysb33r.grolifant.api.v4.exec
Adds configurability via Closure.
toSafeFile(String) - Method in FileUtils
Converts a collection of String into a {@@link File} with all parts guarantee to be safe file parts
toSafeFileName(String) - Method in FileUtils
Converts a string into a string that is safe to use as a file name.
toSafePath(String) - Method in FileUtils
Converts a collection of String into a java.nio.file.Path with all parts guarantee to be safe file parts
toString() - Method in AbstractCloudGit
Content as a string

U

unpack(File, File) - Method in AbstractDistributionInstaller
Unpacks a downloaded archive.
unpackDmgOnMacOsX(ProjectOperations, String, File, String, File) - Method in UnpackUtils
Unpack a DMG image on MacOs.
unpackMSI(File, File, Map<String, String>) - Method in AbstractDistributionInstaller
Provides the capability of unpacking an MSI file under Windows by calling out to msiexec.
UnpackUtils - Class in org.ysb33r.grolifant.api.v4
Utilities to deal with unpacking certain formats.
updateFileProperty(Project, Provider<File>, Object) - Method in FileUtils
Updates a Provider.
uriFromVersion(String) - Method in AbstractDistributionInstaller
Creates a download URI from a given distribution version
UriUtils - Class in org.ysb33r.grolifant.api.v4
Dealing with URIs
urize(Object) - Method in UriUtils
Attempts to convert object to a URI.

V

verifyDistributionRoot(File) - Method in AbstractDistributionInstaller
Validates that the unpacked distribution is good.
verifyDistributionRoot(File) - Method in AbstractSingleFileInstaller
Validates that the downloaded file is good.
verifyDownloadChecksum(String, File, String) - Method in AbstractDistributionInstaller
Verifies the checksum (if provided) of a newly downloaded distribution archive.

W

Windows - Class in org.ysb33r.grolifant.api.v4.os
Windows implementation of OperatingSystem.
Windows() - Constructor in Windows
workingDir - Field in AbstractExecSpec
workingDir(Object) - Method in JavaForkOptions
Sets the working directory for the process.
writePropertiesShellFile(File, Map<String, String>) - Method in AbstractCacheBinaryTask
Write a shell file of properties.
writeWindowsPropertiesBatFile(File, Map<String, String>) - Method in AbstractCacheBinaryTask
Writes a Windows batch file of property values that can be included by a wrapper script.

X

Y

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _