Index (docs 1.2.1 API)

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.
environmentVariable(Object, boolean) - Method in GradleSysEnvProvider
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.
ExclusiveFileAccess - Class in org.ysb33r.grolifant.api.core: Provides co-operative exclusive file access.
ExclusiveFileAccess(int, int) - Constructor in ExclusiveFileAccess: Create exclusive access guard and monitor.
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() - Method in AbstractScriptWrapperTask
exec(E) - Method in ExecMethods: Executes an existing execution specification.
exec(Action<? super ExecSpec>) - Method in ExecOperationsProxy: Executes the specified external process.
ExecConfigurationException - Class in org.ysb33r.grolifant.api.errors: An error occurred trying to configure an execution specification or a resolver for an external tool.
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.
ExecOperationsProxy - Interface in org.ysb33r.grolifant.api.core: Proxies the ExecOperations service that was added in Gradle 6.0, so that equivalent functionality can be provided in Gradle 4.0+
Executable - Interface in org.ysb33r.grolifant.api.v5.runnable
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.
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.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(ProjectLayout, Iterable<Object>) - Method in FileUtils: Converts a collection of file-like objects to a a list of File instances within a project layout.
fileizeDropNull(ProjectLayout, Iterable<Object>) - Method in FileUtils: Converts a collection of file-like objects to a a list of File instances within a project layout.
fileizeOrNull(ProjectLayout, 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.
FileSystemOperationsProxy - Interface in org.ysb33r.grolifant.api.core: Acts as a proxy for the FileSystemOperations that was implemented in Gradle 6.0, but allows for a substitute operation on old Gradle versions.
FileUtils - Class in org.ysb33r.grolifant.api.v6: File utilities that require Gradle 6.0+
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.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(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
getArgumentProviders() - Method in Executable: Argument providers for the application.
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
getBinaryLocationProvider() - Method in AbstractCacheBinaryTask: Obtains location of executable binary or script
getBinaryVersion() - Method in AbstractCacheBinaryTask: Obtains version of binary or script
getBinaryVersionProvider() - Method in AbstractCacheBinaryTask: Obtains version of binary or script
getBootstrapClasspath() - Method in JavaForkOptions: Returns the bootstrap classpath to use for the process.
getByVersion(String) - Method in ExecutableDownloader: Locates, and optionally downloads, an executable by version.
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 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.
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 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 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 the filesystem or in a JAR this will be the location.
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 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(T) - Method in DownloadedExecutable: Given a downloader resolve the path to the exe.
getPath() - Method in OperatingSystem: List of system search paths
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
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 AbstractCacheBinaryTask
getProjectOperations() - Method in AbstractCombinedProjectTaskExtension: Returns a instance of ProjectOperations.
getProjectOperations() - Method in AbstractExecSpec: @return ProjectOperations
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() - 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.
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.
getSdkManCandidateName() - Method in AbstractDistributionInstaller: SDKman candidate name for distribution.
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
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 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.
getTask() - Method in CombinedProjectTaskExtensionBase: 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
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
gradleProperty(Object, boolean) - Method in GradleSysEnvProvider
GradleSysEnvProvider - Interface in org.ysb33r.grolifant.api.core: An proxy to provide system properties, project properties and environmental variables as providers.
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 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
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.
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

javaexec(Action<? super JavaExecSpec>) - Method in ExecOperationsProxy: Executes the specified external java process.
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.

K

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

L

LegacyLevel - Class in org.ysb33r.grolifant.api.core: Internal used enumeration to help with logic with specific Gradle version differences.
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.
log(String) - Method in BaseProgressLogger: Sends a progress message.

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.
NotSupportedException - Class in org.ysb33r.grolifant.api.errors: Feature is not supported on this version of Gradle.

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.core
OperatingSystem.Arch - Enum in org.ysb33r.grolifant.api.core: 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

parseVersionFromOutput(ProjectOperations, Iterable<String>, File, Function<String, String>, Action<ExecSpec>) - Method in ExecUtils: Simplifies running an executable to obtain a version.
PRE_4_10 - Field in LegacyLevel
PRE_4_1 - Field in LegacyLevel
PRE_4_2 - Field in LegacyLevel: @since 1.1
PRE_4_3 - Field in LegacyLevel
PRE_4_5 - Field in LegacyLevel
PRE_4_8 - Field in LegacyLevel
PRE_4_9 - Field in LegacyLevel
PRE_5_0 - Field in LegacyLevel
PRE_5_1 - Field in LegacyLevel
PRE_5_5 - Field in LegacyLevel
PRE_5_6 - Field in LegacyLevel
PRE_6_0 - Field in LegacyLevel
PRE_6_5 - Field in LegacyLevel
PRE_6_6 - Field in LegacyLevel
PRE_7_0 - Field in LegacyLevel: @since 1.1
PRE_7_1 - Field in LegacyLevel: @since 1.0
process(File) - Method in DependencyCache.PostDownloadProcessor
ProgressLogger - Interface in org.ysb33r.grolifant.api.core: Allows implementation against
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: ProjectOperations instance that can be utilised within the task hierarchy
PropertyResolver - Class in org.ysb33r.grolifant.api.v4: Resolves properties in a certain i.e. like SpringBoot, but less functionality to suite Gradle context.
PropertyResolver(ProjectOperations) - Constructor in PropertyResolver: Creates a property resolver with a custom resolve order
provide(String, String, PropertyResolveOrder, boolean) - Method in PropertyResolver: Gets a provider to a property using a specific resolve order.
provideAtConfiguration(String, String) - Method in PropertyResolver: Gets a provider to a property that is safe to use at configuration-time.

Q

R

refresh(URI, File) - Method in DependencyCache.CacheRefresh

registerExecutableKeyActions(NamedResolvedExecutableFactory) - Method in ResolverFactoryRegistry

registerTask(TaskContainer, String, Class<T>, Object) - Method in TaskProvider

Depending on the version of Gradle creates or registers a new task.

relativize(Path, Path) - Method in FileUtils

Returns the path of one Path relative to another.

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.

resolve(Object, Object, boolean) - Method in GradleSysEnvProvider

Resolves a property in order of Gradle, system, environment variable.

resolveClassLocation(Class, FileCollection, Pattern, Pattern, Pattern) - Method in FileUtils

Returns the classpath location for a specific class.

ResolvedExecutableFactory - Interface in org.ysb33r.grolifant.api.v4.exec

Creates a ResolvableExecutable.

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.
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(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.
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.
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.
setTag(Object) - Method in CloudGitConfigurator: 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.
started() - Method in ProgressLogger: Allow logging to start
stringize(Iterable<?>) - Method in StringUtils: Converts a collection of most things to a list of strings.
stringizeDropNull(Iterable<?>) - Method in StringUtils: Like stringize, but drops any nulls, or empty instances of Provider and java.util.Optional
stringizeOrNull(Object) - Method in StringUtils: Like stringize, but returns null rather than throwing an exception, when item is null, an empty {@Link Provider} or an empty java.util.Optional.
stringizeValues(Map<String, Object>) - Method in MapUtils: Evaluates a map of objects to a map of strings.
StringUtils - Class in org.ysb33r.grolifant.api.v4: 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(Object, boolean) - Method in GradleSysEnvProvider
systemProperty(String, Object) - Method in JavaForkOptions: Adds a system property to use for the process.

T

tarTree(Object) - Method in ArchiveOperationsProxy
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, Object) - Method in TaskUtils: Resolves a single item to an existing task instance.
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
toString() - Method in OperatingSystem: Stringize implementation

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.
UnsupportedConfigurationException - Class in org.ysb33r.grolifant.api.errors: Thrown when a type instance cannot be converted to a Gradle-specific type instance.
updateFileProperty(ProjectLayout, ProviderFactory, Property<File>, Object) - Method in FileUtils: Updates a Provider.
updateStringProperty(ProjectOperations, Provider<String>, Object) - Method in StringUtils: 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.
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
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.
Version - Class in org.ysb33r.grolifant.api.core: A class for comparing versions.
Version.ParseException - Class in org.ysb33r.grolifant.api.core
Version.ParseException(String, Throwable) - Constructor in Version.ParseException
Version.Parts - Class in org.ysb33r.grolifant.api.core
Version(String, Version.Parts) - Constructor in Version: Creates an instance of a Version object.

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.
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.