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.wrapper.script
Authors:
Schalk W.
AbstractCacheBinaryTask(String) - Constructor in AbstractCacheBinaryTask
Parameters:
locationPropertiesDefaultName - The default name for the location properties file.
AbstractCloudGit - Class in org.ysb33r.grolifant.api.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
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.exec
Tool execution specification aimed at command-line tools which takes a command as one of the arguments.
AbstractCommandExecSpec(Project, ExternalExecutable) - Constructor in AbstractCommandExecSpec
Construct class and attach it to specific project.
AbstractCommandExecTask - Class in org.ysb33r.grolifant.api.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
Common functionality to be able to download a SDK and use it within Gradle
AbstractDistributionInstaller(String, String, String, Project) - Constructor in AbstractDistributionInstaller
Creates setup for installing to a local cache.
AbstractExecSpec - Class in org.ysb33r.grolifant.api.exec
Abstract base class that implements BaseExecSpec.
AbstractExecSpec(Project) - Constructor in AbstractExecSpec
AbstractExecTask - Class in org.ysb33r.grolifant.api.exec
A base class to use for developing execution tasks for wrapping execution tools
AbstractExecTask() - Constructor in AbstractExecTask
Creates class and sets default environment to be that of Gradle,
AbstractExecWrapperTask - Class in org.ysb33r.grolifant.api.exec
Base task class to wrap external tool executions without exposing command-line parameters directly.
AbstractExecWrapperTask() - Constructor in AbstractExecWrapperTask
AbstractScriptExecSpec - Class in org.ysb33r.grolifant.api.exec
Tool execution specification aimed at script-line tools which takes a script as one of the arguments.
AbstractScriptExecSpec(Project, ExternalExecutable) - Constructor in AbstractScriptExecSpec
Construct class and attach it to specific project.
AbstractScriptExecTask - Class in org.ysb33r.grolifant.api.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.wrapper.script
AbstractScriptWrapperTask() - Constructor in AbstractScriptWrapperTask
AbstractToolExecSpec - Class in org.ysb33r.grolifant.api.exec
A base class to aid plugin developers create their own ExecSpec implementations.
AbstractToolExecSpec(Project, ExternalExecutable) - Constructor in AbstractToolExecSpec
Construct class and attach it to specific project.
AbstractToolExtension - Class in org.ysb33r.grolifant.api.exec
Use as a base class for extensions that will wrap tools.
AbstractToolExtension(Task, String) - Constructor in AbstractToolExtension
Attach this extension to a task
access(File, Callable<T>) - Method in ExclusiveFileAccess
Lock access to a file and perform action.
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, Project, 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.
ArtifactAttributeContainer - Class in org.ysb33r.grolifant.api.artifacts
Implementation of AttributeContainer
attribute(Attribute<T>, T) - Method in ArtifactAttributeContainer
Sets an attribute value.
authentication(Action<? super AuthenticationContainer>) - Method in AuthenticationSupportedRepository
AuthenticationSupportedRepository - Class in org.ysb33r.grolifant.api.repositories
Base class for creating repository types that optionally support authentication.
AuthenticationSupportedRepository(Project) - Constructor in AuthenticationSupportedRepository
Base class constructor

B

BaseProgressLogger - Interface in org.ysb33r.grolifant.api
A simple interface for logging progress to stdout.
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 Packer version.
buildCommandLine() - Method in AbstractToolExecSpec
Builds up the command line.

C

ChecksumCreationException - Class in org.ysb33r.grolifant.api.errors
Failed to create checksum
ChecksumFailedException - Class in org.ysb33r.grolifant.api.errors
Thrown when a checksum fails.
ChecksumFailedException(String, String, File, String, String) - Constructor in ChecksumFailedException
Instantiates an exception.
CheckSumVerification - Interface in org.ysb33r.grolifant.api
Verifies a checksum.
ClassLocation - Interface in org.ysb33r.grolifant.api
============================================================================ (C) Copyright Schalk W.
ClosureUtils - Class in org.ysb33r.grolifant.api
Methods for dealing with closures
CloudGitConfigurator - Interface in org.ysb33r.grolifant.api.git
A description of a Git repository from a cloud provider
CloudGitDescriptor - Interface in org.ysb33r.grolifant.api.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.
command(Object) - Method in AbstractCommandExecSpec
Set the command to use.
command(Object) - Method in AbstractCommandExecTask
Set the command to use.
compareTo(Version) - Method in Version
Compares this object with the specified object for order.
completed() - Method in ProgressLogger
Prevent further logging.
ConfigurationException - Class in org.ysb33r.grolifant.api.errors
A failure has occurred when downloading a distribution of an external tool or SDK.
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.
configureByName(Project, String, Closure) - Method in TaskProvider
Configures a task by name.
configureEach(Project, 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() - Method in AbstractExecTask
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
contains(Attribute<?>) - Method in ArtifactAttributeContainer
Tells if a specific attribute is found in this container.
content(Action) - Method in AuthenticationSupportedRepository
This is currently a NOOP.
copyTo(ProcessForkOptions) - Method in AbstractToolExecSpec
Copies options from this Spec to the given target.
copyTo(ArtifactAttributeContainer) - Method in ArtifactAttributeContainer
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
create(Project) - Method in ExecSpecInstantiator
Instantiates an execution specification.
create(Map<String, Object>, String, Project) - Method in ResolveExecutableByVersion.DownloaderFactory
Creates a downloader
createExecSpec() - Method in AbstractExecTask
Factory method for creating an execution specification
createExecSpec() - Method in AbstractExecWrapperTask
Creates a new execution specification.
createProgressLogger(Project, String) - Method in LogUtils
Creates an instance of a progress logger that could be use to log progress to console
credentials(Class<T>, Action<? super T>) - Method in AuthenticationSupportedRepository
current() - Method in OperatingSystem
Returns a representation of the operating system that the JVM currently runs on.

D

defaultParser(String) - Method in Version
The default parser will look for something that roughly matches the following regex: {@code \d+\.
DependencyCache - Class in org.ysb33r.grolifant.api.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.artifacts
DependencyCache.PostDownloadProcessor - Interface in org.ysb33r.grolifant.api.artifacts
DependencyCache(Project, String, String, DependencyCache.CacheRefresh, CheckSumVerification, DependencyCache.PostDownloadProcessor) - Constructor in DependencyCache
DistributionFailedException - Class in org.ysb33r.grolifant.api.errors
Thrown when a distribution failed to unpack correctly or does not meet specific criteria.
DownloadFailedException - Class in org.ysb33r.grolifant.api.errors
Failure to download an item.

E

env - Field in AbstractExecSpec
environment(String, Object) - Method in AbstractExecSpec
Add additional environment variable for use with the process.
environment(String, Object) - Method in AbstractExecTask
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 AbstractExecTask
Set the stream where error output should be sent to for this process when executing.
ExclusiveFileAccess - Class in org.ysb33r.grolifant.api
Provides co-operative exclusive file access.
ExclusiveFileAccess(int, int) - Constructor in ExclusiveFileAccess
Create exclusive access guard and monitor.
exeArgs(Object) - Method in AbstractExecTask
Add more tool-specific arguments.
exeArgs(Object) - Method in AbstractToolExecSpec
Add more tool-specific arguments.
exec() - Method in AbstractCacheBinaryTask
exec() - Method in AbstractExecTask
Runs this process against an internal execution specification.
exec() - Method in AbstractExecWrapperTask
The default implementation will build an execution specification and run it.
exec() - Method in AbstractScriptWrapperTask
ExecConfigurationException - Class in org.ysb33r.grolifant.api.errors
An error occurred trying to configure an execution specification or a resolver for an external tool.
ExecSpecInstantiator - Interface in org.ysb33r.grolifant.api.exec
Factory interface for instantiating execution specification.
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.
ExecutionException - Class in org.ysb33r.grolifant.api.errors
A failure occurred running or setting up an execution specification.
ExtensionUtils - Class in org.ysb33r.grolifant.api
Utilities to deal with Gradle extensions and project extensions
ExternalExecutable - Interface in org.ysb33r.grolifant.api.exec
A way to create a lazy-evaluated location of an external executable.
ExternalExecutableType - Interface in org.ysb33r.grolifant.api.exec
A way to create a lazy-evaluated parameters of an external executable.

F

filesFromCopySpec(CopySpec) - Method in FileUtils
Returns the file collection that a CopySpec describes.
FileUtils - Class in org.ysb33r.grolifant.api
findAllInPath(String) - Method in OperatingSystem
Find all files in system search path of a certain name.
findInPath(String) - Method in OperatingSystem
Locates the given exe in the system path.
findValidKey(Map<String, Object>) - Method in ResolverFactoryRegistry
Look for exactly one valid key in the supplied map.
FreeBSD - Class in org.ysb33r.grolifant.api.os
FreeBSD implementation of OperatingSystem.

G

GenericBSD - Class in org.ysb33r.grolifant.api.os
Abstract base class for BSD-based operating systems.
GenericBSD() - Constructor in GenericBSD
GenericUnix - Class in org.ysb33r.grolifant.api.os
Generic Unix-like implementation of OperatingSystem.
GenericUnix() - Constructor in GenericUnix
get(String, String, PropertyResolveOrder) - Method in PropertyResolver
Gets a property using a specific resolve order
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 OperatingSystem
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.
getArchiveUri() - Method in CloudGitDescriptor
Obtains the URI for the archive of the repository.
getArchStr() - Method in GenericUnix
Implementation-specific free-form architecture string.
getArchStr() - Method in OperatingSystem
Architecture underlying the operating system
getArchStr() - Method in Solaris
Solaris-specific architecture strings.
getArchStr() - Method in Windows
Architecture underlying the operating system
getAttribute(Attribute<T>) - Method in ArtifactAttributeContainer
Returns the value of an attribute found in this container, or null if this container doesn't have it.
getAttributes() - Method in ArtifactAttributeContainer
getAuthentication() - Method in AuthenticationSupportedRepository
getBeginToken() - Method in AbstractScriptWrapperTask
If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the start token delimiter.
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
getChecksum() - Method in CheckSumVerification
Returns the checksum in question.
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 AbstractExecTask
Returns the full script line, including the exe, it's specific arguments, tool specific instruction and the arguments specific to the instruction.
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.
getDistributionRoot() - Method in AbstractDistributionInstaller
Returns the location which is the top or home folder for a distribution.
getEnableAssertions() - Method in JavaForkOptions
Returns true if assertions are enabled for the process.
getEndToken() - Method in AbstractScriptWrapperTask
If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the end token delimiter.
getEnvironment() - Method in AbstractExecSpec
Returns the environment to be used for the process.
getEnvironment() - Method in AbstractExecTask
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.
getErrorOutput() - Method in AbstractExecTask
Where error output is sent to during execution.
getExeArgs() - Method in AbstractExecTask
Any arguments specific to the tool in use
getExeArgs() - Method in AbstractToolExecSpec
Any arguments specific to the tool in use
getExecResult() - Method in AbstractExecTask
Returns the result for the execution, that was run by this task.
getExecSpec() - Method in AbstractExecTask
Provides access to the execution specification that is associated with this task
getExecutable() - Method in AbstractExecTask
The exe used in this specification as a String.
getExecutable() - Method in AbstractToolExecSpec
The exe used in this specification as a String.
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 OperatingSystem
Returns OS-specific decorated 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 OperatingSystem
Returns list of possible OS-specific decorated exe names.
getExecutableNames(String) - Method in Windows
getExecutableResolver() - Method in AbstractToolExecSpec
Access to the object that can resolve exe location from property maps.
getFile() - Method in ClassLocation
If the class is located on th e filesystem or in a JAR this will be the location.
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 checksum in question.
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 CloudGitDescriptor
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
getOrganisation() - Method in CloudGitDescriptor
Organisation on Git cloud service
getPath() - Method in OperatingSystem
List of system search paths
getPath(T) - Method in ResolveExecutableByVersion.DownloadedExecutable
Given a downloader resolve the path to the exe.
getPathSeparator() - Method in OperatingSystem
The character used to separate elements in a system search path
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
getProjectExtension() - Method in AbstractCombinedProjectTaskExtension
Returns the extension that is attached to the project.
getPropertiesDescription() - Method in AbstractCacheBinaryTask
Obtains a description to be added to the cached binary properties file.
getRepository() - Method in AbstractCloudGit
Get the repository
getRepository() - Method in CloudGitDescriptor
Repository on Git cloud service
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(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
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.
getRuntime() - Method in ClassLocation
If the class is located in a runtime module
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 OperatingSystem
Returns OS-specific decorated script name.
getScriptName(String) - Method in Windows
Returns Windows-specific decorated script name.
getSharedLibraryName(String) - Method in GenericUnix
Returns OS-specific shared library name
getSharedLibraryName(String) - Method in OperatingSystem
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
getSharedLibrarySuffix() - Method in OperatingSystem
OS-dependent string that is used to suffix to shared libraries
getStandardInput() - Method in AbstractExecSpec
Where input is read from during execution.
getStandardInput() - Method in AbstractExecTask
Where input is read from during execution.
getStandardOutput() - Method in AbstractExecSpec
Where standard output is sent to during execution.
getStandardOutput() - Method in AbstractExecTask
Where standard output is sent to during execution.
getStaticLibraryName(String) - Method in GenericUnix
Returns OS-specific static library name
getStaticLibraryName(String) - Method in OperatingSystem
Returns OS-specific static library name
getStaticLibraryName(String) - Method in Windows
Returns OS-specific static library name
getStaticLibrarySuffix() - Method in OperatingSystem
OS-dependent string that is used to suffix to static libraries
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.
getTokenValuesAsMap() - Method in AbstractScriptWrapperTask
If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the collection of tokens.
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
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.
getWorkingDir() - Method in AbstractExecSpec
Obtain the working directory for this process.
getWorkingDir() - Method in AbstractExecTask
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.git
Describes a GitHub archive
GitHubArchive() - Constructor in GitHubArchive
GitLabArchive - Class in org.ysb33r.grolifant.api.git
Describes a GitLab archive.
GitLabArchive() - Constructor in GitLabArchive
GitRepoArchiveDownloader - Class in org.ysb33r.grolifant.api.git
Downloads an archive of a Git repository.
GitRepoArchiveDownloader(CloudGitDescriptor, Project) - Constructor in GitRepoArchiveDownloader
GrolifantError - Interface in org.ysb33r.grolifant.api.errors
A token interface for exception arising out of Grolifant library.

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 AbstractExecTask
Determine whether the exit value should be ignored.
INSTANCE - Field in Windows
instructionArgs(Object) - Method in AbstractToolExecSpec
Add more instruction-specific arguments.
isEmpty() - Method in ArtifactAttributeContainer
Returns true if this container is empty.
isFreeBSD() - Method in FreeBSD
isFreeBSD() - Method in OperatingSystem
Check is this is FreeBSD
isIgnoreExitValue() - Method in AbstractExecSpec
State of exit value monitoring.
isIgnoreExitValue() - Method in AbstractExecTask
State of exit value monitoring.
isLinux() - Method in Linux
Confirms that this is an OS representation of a Linux operating system.
isLinux() - Method in OperatingSystem
Check is this is a Linux flavour
isMacOsX() - Method in MacOsX
Confirms that this is an OS representation of a Mac operating system.
isMacOsX() - Method in OperatingSystem
Check is this is Apple Mac OS X
isNetBSD() - Method in NetBSD
Confirms that this is an OS representation NetBSD.
isNetBSD() - Method in OperatingSystem
Check is this is NetBSD
isSolaris() - Method in OperatingSystem
Check is this is a Solaris flavour
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.
isUnix() - Method in OperatingSystem
Check is this is any kind of Unix-like O/S
isWindows() - Method in OperatingSystem
Check is this is Microsoft Windows
isWindows() - Method in Windows
Confirms this is a representation of the Microsoft Windows operating system.

J

JavaForkOptions - Class in org.ysb33r.grolifant.api
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.

K

keySet() - Method in ArtifactAttributeContainer
Returns the set of attribute keys of this container.

L

Linux - Class in org.ysb33r.grolifant.api.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.
log(String) - Method in BaseProgressLogger
Sends a progress message.
LogUtils - Class in org.ysb33r.grolifant.api
Various utilities related to logging.

M

MacOsX - Class in org.ysb33r.grolifant.api.os
MacOSX implementation of OperatingSystem.
MapUtils - Class in org.ysb33r.grolifant.api
Various utilities dealing with key-value pairs.

N

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

O

of(String, Function<String, Parts>) - Method in Version
Creates a new version instance from a parse-able string using a custom parser
OperatingSystem - Class in org.ysb33r.grolifant.api
OperatingSystem.Arch - Enum in org.ysb33r.grolifant.api
Enumeration representing common hardware-operating system architectures.
OperatingSystem() - Constructor in OperatingSystem
order(PropertyResolveOrder) - Method in PropertyResolver
Change the existing property order
OS_ARCH - Field in OperatingSystem
OS_NAME - Field in OperatingSystem
OS_VERSION - Field in OperatingSystem

P

process(File) - Method in DependencyCache.PostDownloadProcessor
ProgressLogger - Interface in org.ysb33r.grolifant.api
Allows implementation against
project - Field in AbstractExecSpec
PROJECT_SYSTEM_ENV - Field in PropertyResolver
projectCacheDirFor(Project) - Method in FileUtils
Returns the project cache directory for the given project.
PropertyResolveOrder - Interface in org.ysb33r.grolifant.api
============================================================================ (C) Copyright Schalk W.
PropertyResolver - Class in org.ysb33r.grolifant.api
Resolves properties in a certain i.e. like SprintBoot, but less functionality to suite Gradle context.
PropertyResolver(Project, PropertyResolveOrder) - Constructor in PropertyResolver
Creates a property resolver with a custom resolve order

Q

R

refresh(URI, File) - Method in DependencyCache.CacheRefresh
registerExecutableKeyActions(NamedResolvedExecutableFactory) - Method in ResolverFactoryRegistry
Register more ways of locating executables.
registerTask(Project, 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.exec
Holds a reference to an exe that will only be made available when explicitly called.
ResolvableExecutableType - Interface in org.ysb33r.grolifant.api.exec
Authors:
Schalk W.
resolve(Project, String) - Method in PropertyResolveOrder
Resolves the property within the context of a GRadle project
resolveClassLocation(Class) - Method in FileUtils
Returns the classpath location for a specific class
ResolvedExecutable - Interface in org.ysb33r.grolifant.api.exec
Holds a reference to an exe that will only be made available when explicitly called.
ResolvedExecutableFactory - Interface in org.ysb33r.grolifant.api.exec
ResolveExecutableByVersion - Class in org.ysb33r.grolifant.api.exec
Uses an implementation of an AbstractDistributionInstaller to find an exe by version number.
ResolveExecutableByVersion.DownloadedExecutable - Interface in org.ysb33r.grolifant.api.exec
ResolveExecutableByVersion.DownloaderFactory - Interface in org.ysb33r.grolifant.api.exec
ResolveExecutableByVersion(Project, ResolveExecutableByVersion.DownloaderFactory, ResolveExecutableByVersion.DownloadedExecutable) - Constructor in ResolveExecutableByVersion
Resolve by downloadable version.
ResolverFactoryRegistry - Class in org.ysb33r.grolifant.api.exec
A registry of factories for locating executables.
ResolverFactoryRegistry(Project) - Constructor in ResolverFactoryRegistry
Create a registry of factories for locating executables
runExecSpec(T) - Method in AbstractExecWrapperTask

S

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.
setBaseUri(URI) - Method in CloudGitConfigurator
setBootstrapClasspath(FileCollection) - Method in JavaForkOptions
Sets the bootstrap classpath to use for the process.
setBranch(Object) - Method in AbstractCloudGit
Set the branch.
setBranch(Object) - Method in CloudGitConfigurator
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.
setCommit(Object) - Method in CloudGitConfigurator
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.
setDeleteTemplatesAfterUsage(boolean) - Method in AbstractScriptWrapperTask
Whether templates should be deleted after usage.
setDownloadRoot(File) - 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 AbstractExecTask
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.
setErrorOutput(OutputStream) - Method in AbstractExecTask
Set the stream where error output should be sent to for this process when executing.
setExeArgs(Iterable<?>) - Method in AbstractExecTask
Replace the tool-specific arguments with a new set.
setExeArgs(Iterable<?>) - Method in AbstractToolExecSpec
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.
setIgnoreExitValue(boolean) - Method in AbstractExecSpec
setIgnoreExitValue(boolean) - Method in AbstractExecTask
Determine whether the exit value should be ignored.
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.
setOrganisation(Object) - Method in CloudGitConfigurator
Set the organisation.
setRepository(Object) - Method in AbstractCloudGit
Set the repository
setRepository(Object) - Method in CloudGitConfigurator
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.
setStandardInput(InputStream) - Method in AbstractExecTask
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.
setStandardOutput(OutputStream) - Method in AbstractExecTask
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.
setTag(Object) - Method in CloudGitConfigurator
Set the tag.
setToolExecutable(Object) - Method in AbstractExecTask
Sets the exe to use for this task
setWorkingDir(File) - Method in AbstractExecSpec
Set the working directory for the execution.
setWorkingDir(Object) - Method in AbstractExecTask
Set the working directory for the execution.
setWorkingDir(Object) - Method in JavaForkOptions
Sets the working directory for the process.
SimplePasswordCredentials - Class in org.ysb33r.grolifant.api.repositories
Simple memory-based implementation of password credentials.
Solaris - Class in org.ysb33r.grolifant.api.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 AbstractExecTask
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 AbstractExecTask
Set the stream where standard output should be sent to for this process when executing.
started() - Method in ProgressLogger
Allow logging to start
stringize(Iterable<?>) - Method in StringUtils
Converts a collection of most things to a list of strings.
stringizeValues(Map<String, Object>) - Method in MapUtils
Evaluates a map of objects to a map of strings.
StringUtils - Class in org.ysb33r.grolifant.api
A collection of utilities for converting to 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(Project, String) - Method in TaskProvider
Finds a task on the given project by name
taskByTypeAndName(Project, Class, String) - Method in TaskProvider
Finds a task by both type and name
TaskProvider - Class in org.ysb33r.grolifant.api
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.
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
toString() - Method in OperatingSystem
Stringize implementation

U

unpack(File, File) - Method in AbstractDistributionInstaller
Unpacks a downloaded archive.
unpackDmgOnMacOsX(Project, 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
Utilities to deal with unpacking certain formats.
uriFromVersion(String) - Method in AbstractDistributionInstaller
Creates a download URI from a given distribution version
UriUtils - Class in org.ysb33r.grolifant.api
Dealing with URIs
urize(Object) - Method in UriUtils
Attempts to convert object to a URI.
useWrapperTemplatesInResources(String, Map<String, String>) - Method in AbstractScriptWrapperTask
Use wrapper templates from resources classpath

V

verify(File) - Method in CheckSumVerification
Verifies a file against a checksum
verifyDownloadChecksum(String, File, String) - Method in AbstractDistributionInstaller
Verifies the checksum (if provided) of a newly downloaded distribution archive.
Version - Class in org.ysb33r.grolifant.api
A class for comparing versions.
Version.ParseException - Class in org.ysb33r.grolifant.api
Version.ParseException(String, Throwable) - Constructor in Version.ParseException
Version.Parts - Class in org.ysb33r.grolifant.api
Version(String, Version.Parts) - Constructor in Version
Creates an instance of a Version object.

W

Windows - Class in org.ysb33r.grolifant.api.os
Windows implementation of OperatingSystem.
Windows() - Constructor in Windows
workingDir - Field in AbstractExecSpec
workingDir(Object) - Method in AbstractExecTask
Set the working directory for the execution.
workingDir(Object) - Method in JavaForkOptions
Sets the working directory for the process.
WrapperCreationException - Class in org.ysb33r.grolifant.api.errors
Thrown when a tool wrapper script cannot be created.
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 _