Index (grolifant5-core 5.6.0 API)

A specification to something non-JVM that can be executed out-of-process and can then be used to copy to other methods in the Gradle API that provides a ExecSpec in the parameters.

appRunnerSpec - Field in AbstractExecSpec

appRunnerSpec() - Method in ExecTools

Creates a AppRunnerSpec.

archiveUriProvider - Property in AbstractCloudGit

args(Iterable<?>) - Method in AbstractCmdlineArgumentSpec

Add arguments to the entrypoint.

args(Iterable<?>) - Method in CmdlineArgumentSpec

Add arguments to the entrypoint.

argumentSpec - Property in CmdLineArgumentSpecEntry

ARM32 - Enum Constant in OperatingSystem.Arch

ARM 32-bit.

ARM64 - Enum Constant in OperatingSystem.Arch

ARM 64-bit.

ArtifactDownloader - Class in org.ysb33r.grolifant5.api.core.downloader

Performs low-level downloading work.

ArtifactDownloader(java.net.URI, java.io.File, org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations, java.lang.String, org.ysb33r.grolifant5.api.core.downloader.ArtifactRequiresDownload, org.ysb33r.grolifant5.api.core.CheckSumVerification) - Constructor in ArtifactDownloader

Downloads an artifact without unpacking it.

ArtifactRequiresDownload - Interface in org.ysb33r.grolifant5.api.core.downloader

Indicates whether download is required.

ArtifactRootVerification - Interface in org.ysb33r.grolifant5.api.core.downloader

Verifies a artifact root

artifactRootVerification - Property in AbstractDistributionInstaller

ArtifactUnpacker - Interface in org.ysb33r.grolifant5.api.core.downloader

Unpacks an artifact.

artifactUnpacker - Property in AbstractDistributionInstaller

asConfiguration(java.lang.Object) - Method in ConfigurationTools

Resolves an arbitrary item to a Configuration instance.

asConfigurations(Collection<?>) - Method in ConfigurationTools

Resolves arbitrary items to a collection of Configuration instances.

asProvider() - Method in ProjectOperations

A provider to this instance.

asRepositoryCredentials() - Method in SimplePasswordCredentials

assertNormalExitValue() - Method in ExecOutput

Throws an exception if the process exited with a non-standard exit value.

atConfigurationTime() - Method in ProjectOperations

Value that can be read safely at configuration time

atConfigurationTime() - Method in ProviderTools

Value that can be read safely at configuration time

authenticationContainer() - Method in RepositoryTools

Creates an instance of an AuthenticationContainer

await() - Method in WorkerPromise

Blocks until all work related to the queue is completed.

B

BaseProgressLogger - Interface in org.ysb33r.grolifant5.api.core: A simple interface for logging progress to stdout.
BaseScriptDefinition - Class in org.ysb33r.grolifant5.api.core.executable: Defines a base class for implementing a basic script definition.
BaseScriptDefinition.1 - Class in org.ysb33r.grolifant5.api.core.executable
BaseScriptDefinition.1() - Constructor in BaseScriptDefinition.1
BaseScriptDefinition.2 - Class in org.ysb33r.grolifant5.api.core.executable
BaseScriptDefinition.2() - Constructor in BaseScriptDefinition.2
BaseScriptDefinition(org.ysb33r.grolifant5.api.core.ProjectOperations) - Constructor in BaseScriptDefinition
BaseScriptSpec - Interface in org.ysb33r.grolifant5.api.core.executable: Describes how to configure a script and its arguments.
BaseToolLocation - Interface in org.ysb33r.grolifant5.api.core.runnable: Sets the definition on how to find a tool.
beforeEvaluate(org.gradle.api.Project) - Method in GrolifantServicePlugin.ProjectVersionEvaluator
beta - Property in Version: Whether the version is a beta.
beta - Property in Version.Parts
betaSequence - Property in Version
buildDirDescendant(java.lang.Object) - Method in ConfigurationPhaseOperations: Safely resolve the stringy item as a path relative to the build directory.
buildDirDescendant(java.lang.Object) - Method in FileSystemOperations: Safely resolve the stringy item as a path relative to the build directory.
buildDirDescendant(java.lang.Object) - Method in ProjectOperations: Safely resolve the stringy item as a path relative to the build directory.
buildDirDirectory(java.lang.Object) - Method in FileSystemOperations: Like buildDirDescendant(Object), but return a provider to a Directory instead.
buildDirRegularFile(java.lang.Object) - Method in FileSystemOperations: Like buildDirDescendant(Object), but return a provider to a RegularFile instead.
bzip2Resource(java.lang.Object) - Method in ConfigurationPhaseOperations: Creates a resource that points to a bzip2 compressed file at the given path.
bzip2Resource(java.lang.Object) - Method in FileSystemOperations: Creates resource that points to a bzip2 compressed file at the given path.
bzip2Resource(java.lang.Object) - Method in ProjectOperations: Creates resource that points to a bzip2 compressed file at the given path.

C

CacheRefresh - Interface in org.ysb33r.grolifant5.api.core.artifacts

Performs a cache refresh of a set of dependencies.

call() - Method in AbstractBaseToolExtension.1

call() - Method in AbstractBaseToolExtension.2

call() - Method in AbstractBaseToolExtension.3

call() - Method in AbstractBaseToolExtension.4

call() - Method in AbstractDistributionInstaller.1

call() - Method in AbstractToolExtension.1

call() - Method in AbstractToolExtension.2

call() - Method in AbstractWrapperGeneratorTask.1

call() - Method in BaseScriptDefinition.1

call() - Method in BaseScriptDefinition.2

CAPTURE - Enum Constant in ExecTools.OutputType

Capture output, but produce no output.

capture() - Method in OutputStreamSpec

Captures the output of the running process.

captureAndForward() - Method in OutputStreamSpec

Captures the output of the running process, but also forwards it to console.

captureTo(Provider<File>) - Method in OutputStreamSpec

Capture output to this the given file.

caseConversion(org.ysb33r.grolifant5.api.core.CaseFormats, org.ysb33r.grolifant5.api.core.CaseFormats, java.lang.Object) - Method in StringTools

Converts a string in one format to another.

CaseFormats - Enum in org.ysb33r.grolifant5.api.core

Simple case formats.

ccso - Field in AbstractNativeToolchain

ccso - Field in CombinedProjectTaskExtensionBase

ChecksumCreationException - Class in org.ysb33r.grolifant5.api.errors

Failed to create checksum

ChecksumCreationException() - Constructor in ChecksumCreationException

ChecksumFailedException - Class in org.ysb33r.grolifant5.api.errors

Thrown when a checksum fails.

ChecksumFailedException(java.lang.String, java.lang.String, java.io.File, java.lang.String, java.lang.String) - Constructor in ChecksumFailedException

Instantiates an exception.

CheckSumVerification - Interface in org.ysb33r.grolifant5.api.core

Verifies a checksum.

ClassLocation - Interface in org.ysb33r.grolifant5.api.core

Describes the location of a class.

ClassLocationException - Class in org.ysb33r.grolifant5.api.errors

Thrown when a class location search failed.

ClassLocationException() - Constructor in ClassLocationException

classpath(java.lang.Object) - Method in ClasspathSpec

Add paths to the execution classpath.

CLASSPATH - Enum Constant in ExecutionMode

CLASSPATH - Enum Constant in WorkerIsolation

ClasspathSpec - Interface in org.ysb33r.grolifant5.api.core.jvm

Defined the classpath for a JVM operation.

close() - Method in GrolifantSecurePropertyService

ClosureUtils - Class in org.ysb33r.grolifant5.api.core

Methods for dealing with closures.

ClosureUtils() - Constructor in ClosureUtils

CloudGitConfigurator - Interface in org.ysb33r.grolifant5.api.core.git

A description of a Git repository from a cloud provider

CloudGitDescriptor - Interface in org.ysb33r.grolifant5.api.core.git

A description of a Git repository from a cloud provider

cmd(Closure<?>) - Method in AbstractCommandExecSpec

Configures the command along with its arguments.

cmd(Closure<?>) - Method in AbstractCommandExecTask

Configures the command along with its arguments.

cmd(Closure<?>) - Method in ExecutableCommand

Configures the command along with its arguments.

CmdlineArgumentSpec - Interface in org.ysb33r.grolifant5.api.core

Specifies the entrypoint and arguments for running something on a JVM.

CmdLineArgumentSpecEntry - Class in org.ysb33r.grolifant5.api.core.executable

Representation of a command-line specification and its order in processing.

CmdLineArgumentSpecEntry(java.lang.String, java.lang.Integer, org.ysb33r.grolifant5.api.core.CmdlineArgumentSpec) - Constructor in CmdLineArgumentSpecEntry

CombinedProjectTaskExtensionBase - Class in org.ysb33r.grolifant5.api.core.runnable

Base class for an extension that can both be used on a project or a task.

CombinedProjectTaskExtensionBase(org.gradle.api.Task, T) - Constructor in CombinedProjectTaskExtensionBase

Attach this extension to a task

COMMAND_BLOCK - Field in AbstractCommandExecSpec

CommandEntryPoint - Interface in org.ysb33r.grolifant5.api.core.executable

Configures a command along with its arguments.

commandEntryPoint() - Method in ExecTools

Returns an implementation that is optimised for the running version of Gradle.

CommandLineArgumentProviders - Interface in org.ysb33r.grolifant5.api.core

A system that can lister a list of providers of command-line arguments.

compareTo(org.ysb33r.grolifant5.api.core.executable.CmdLineArgumentSpecEntry) - Method in CmdLineArgumentSpecEntry

compareTo(org.ysb33r.grolifant5.api.core.Version) - Method in Version

Compares this object with the specified object for order.

completed() - Method in ProgressLogger

Prevent further logging.

ConfigCacheSafeExecMethods - Interface in org.ysb33r.grolifant5.api.core.runnable

Execution methods that can be applied to an extension, copied from an extension and be safely applied to task action when configuration caching is active.

ConfigCacheSafeOperations - Interface in org.ysb33r.grolifant5.api.core

Provides methods to access all the main Grolifant components.

configCacheSafeOperations - Field in AbstractDistributionInstaller

Project operations that can used during downloading.

ConfigurationException - Class in org.ysb33r.grolifant5.api.errors

A failure has occurred when downloading a distribution of an external tool or SDK.

ConfigurationException() - Constructor in ConfigurationException

ConfigurationPhaseOperations - Interface in org.ysb33r.grolifant5.api.core

A set of tools that can be used during the configuration phase.

ConfigurationTools - Interface in org.ysb33r.grolifant5.api.core

Additional tools to work with configurations.

configurationTools() - Method in ConfigurationPhaseOperations

Access to a number of tools for manipulating Gradle configurations.

configureCmdline(java.lang.String, Closure<?>) - Method in AppRunnerSpec

Configures a CmdlineArgumentSpec instance.

configureCmdline(Closure<?>) - Method in JvmAppRunnerSpec

Configures a CmdlineArgumentSpec instance.

configureEntrypoint(Closure<?>) - Method in AppRunnerSpec

Configures a ExecutableEntryPoint instance.

configureEntrypoint(Closure<?>) - Method in JvmAppRunnerSpec

Configures a JvmEntryPoint instance.

configureForkOptions(Closure<?>) - Method in JvmAppRunnerSpec

Configures a JavaForkOptionsWithEnvProvider instance.

configureFrom(org.ysb33r.grolifant5.api.core.jvm.GrolifantSimpleJavaForkOptions) - Method in JavaForkOptionsWithEnvProvider

Configures from an existing instance of GrolifantSimpleJavaForkOptions.

configureItem(java.lang.Object, groovy.lang.Closure) - Method in ClosureUtils

Configure this item using a closure

configureProcess(Closure<?>) - Method in AppRunnerSpec

Configures a ProcessExecutionSpec.

configureProcess(Closure<?>) - Method in JvmAppRunnerSpec

Configures a ProcessExecutionSpec.

convertItem(java.lang.Object, Function<Object,OUT>) - Method in Transform

Converts an item using a specified transformer.

convertItemOrNull(java.lang.Object, Function<Object,OUT>) - Method in Transform

Converts an item using a specified transformer.

convertItems(Collection<?>, Collection<OUT>, Function<Object,OUT>) - Method in Transform

Converts a collection type using a specified transformer

convertItemsDropNull(Collection<?>, Collection<OUT>, Function<Object,OUT>) - Method in Transform

Converts a collection type using a specified transformer

convertTo(org.ysb33r.grolifant5.api.core.CaseFormats, java.lang.String) - Method in CaseFormats

Converts an input which is in this format to another format

convertWithoutCaseCorrection(org.ysb33r.grolifant5.api.core.CaseFormats, java.lang.String) - Method in CaseFormats

Converts an input which is in this format to another format.

copy(Action<? super CopySpec>) - Method in FileSystemOperations

Copies the specified files.

CopyDebugOptions - Interface in org.ysb33r.grolifant5.api.core.jvm

Interface for copying JVM debug options.

copyDebugOptions(org.ysb33r.grolifant5.api.core.jvm.JvmDebugOptions, org.gradle.process.JavaForkOptions) - Method in CopyDebugOptions

Proxies between JvmDebugOptions and Gradle's JavaDebugOptions.

copyResourceToFile(java.lang.String, java.io.File) - Method in FileSystemOperations

Copies the file at the resource path to a local file.

copySpec(Action<? super CopySpec>) - Method in ConfigurationPhaseOperations

Creates a CopySpec which can later be used to copy files or create an archive.

copySpec(Closure<?>) - Method in FileSystemOperations

Creates a copy specification and configures it.

copySpec(Action<? super CopySpec>) - Method in ProjectOperations

Creates a CopySpec which can later be used to copy files or create an archive.

copyTo(org.gradle.process.ExecSpec) - Method in AbstractExecSpec

Copies this specification to a standard ExecSpec.

copyTo(org.gradle.process.JavaExecSpec) - Method in AbstractJvmExecSpec

Copies this specification to a standard JavaExecSpec.

copyTo(org.gradle.process.ExecSpec) - Method in AppRunnerSpec

Copies these options to the given options.

copyTo(org.gradle.process.ExecSpec) - Method in ExecutableOperations

Copies this specification to a standard ExecSpec.

copyTo(org.gradle.process.ProcessForkOptions) - Method in GrolifantProcessForkOptions

copyTo(org.gradle.process.JavaForkOptions) - Method in GrolifantSimpleJavaForkOptions

Copies settings to JavaForkOptions.

copyTo(org.gradle.process.JavaExecSpec) - Method in JvmAppRunnerSpec

Copies these options to the given options.

copyTo(org.ysb33r.grolifant5.api.core.jvm.GrolifantSimpleJavaForkOptions, org.gradle.process.JavaForkOptions) - Method in JvmTools

Updates a JavaForkOptions instance from a GrolifantSimpleJavaForkOptions instance.

copyWrappersFromResources(java.lang.String, Map<String, String>) - Method in ToolWrapper

Copy wrapper templates from resources into a temporary directory

create(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations, org.ysb33r.grolifant5.spi.unpackers.GrolifantUnpacker.Parameters) - Method in GrolifantUnpacker

Creates a new unpack engine along with additional parameters.

create(org.gradle.api.Project) - Method in ProjectOperations

Creates a reference to ProjectOperations instance.

createAndConfigure(org.ysb33r.grolifant5.api.core.jvm.worker.WorkerExecSpec) - Method in StandardWorkerAppParameterFactory

Parameters:: execSpec - Java execution specification that can be used for setting worker execution details.

createAndConfigure(org.ysb33r.grolifant5.api.core.jvm.worker.WorkerExecSpec) - Method in WorkerAppParameterFactory

Parameters:: execSpec - Java execution specification that can be used for setting worker execution details.

createExecSpec() - Method in ProvisionedExecMethods

Create execution specification.

createExecSpec() - Method in ProvisionedJvmExecMethods

Create execution specification.

createExecutorFactory() - Method in AbstractJvmExecTask

Create a worker app executor factory.

createExecutorFactory() - Method in AbstractJvmModelExecTask

Create a worker app executor factory.

createLocalRoleFocusedConfiguration(java.lang.String, java.lang.String, boolean) - Method in ConfigurationTools

Creates two configurations that are related to each other and which are only meant to be used within the same (sub)project.

createParameterFactory() - Method in AbstractJvmExecTask

Create a worker app parameter factory.

createParameterFactory() - Method in AbstractJvmModelExecTask

Create a worker app parameter factory.

createRoleFocusedConfigurations(java.lang.String, java.lang.String, java.lang.String, boolean, Action<? super AttributeContainer>) - Method in ConfigurationTools

Creates three configurations that are related to each other.

createSingleOutgoingConfiguration(java.lang.String, boolean, Action<? super AttributeContainer>) - Method in ConfigurationTools

Creates a single configuration to be used for outgoing publications.

createTempDirectory(java.lang.String) - Method in FileSystemOperations

Creates a temporary directory with the given prefix.

current() - Method in OperatingSystem

Returns a representation of the operating system that the JVM currently runs on.

D

DEFAULT_BLOCK - Field in AppRunnerSpec

The default command-line block name.

defaultParser(java.lang.String) - Method in Version

The default parser will look for something that roughly matches the following regex: {

code:: \d+\.

delete(Action<? super DeleteSpec>) - Method in ConfigurationPhaseOperations

Deletes the specified files.

delete(Action<? super DeleteSpec>) - Method in FileSystemOperations

Deletes the specified files.

delete(Action<? super DeleteSpec>) - Method in ProjectOperations

Deletes the specified files.

DependencyCache - Class in org.ysb33r.grolifant5.api.core.artifacts

A custom implementation of a dependency cache when the one from Gradle might not be directly accessible.

DependencyCache.1 - Class in org.ysb33r.grolifant5.api.core.artifacts

DependencyCache.1() - Constructor in DependencyCache.1

DependencyCache(org.gradle.api.Project, java.lang.String, java.lang.String, org.ysb33r.grolifant5.api.core.artifacts.CacheRefresh, org.ysb33r.grolifant5.api.core.CheckSumVerification, org.ysb33r.grolifant5.api.core.artifacts.PostDownloadProcessor) - Constructor in DependencyCache

Parameters:: project - Project context.

distributionDir - Property in DownloadedLocalFile

DistributionFailedException - Class in org.ysb33r.grolifant5.api.errors

Thrown when a distribution failed to unpack correctly or does not meet specific criteria.

DistributionFailedException() - Constructor in DistributionFailedException

DistributionInstaller - Interface in org.ysb33r.grolifant5.api.core.downloader

Interface for a downloader and unpacker of distributions.

distributionName - Field in AbstractDistributionInstaller

Name of the distribution.

distributionUrl - Property in DownloadedLocalFile

download(java.net.URI, java.io.File) - Method in ArtifactRequiresDownload

Indicates whether download is required.

download(java.net.URI, java.io.File) - Method in DependencyCache.1

download(java.net.URI, java.io.File) - Method in Downloader

Downloads a package / distribution / file

downloadedFile - Property in DownloadedLocalFile

DownloadedLocalFile - Class in org.ysb33r.grolifant5.api.core.downloader

Provides information on where a downloaded file ends up.

DownloadedLocalFile(java.io.File, java.io.File, java.net.URI) - Constructor in DownloadedLocalFile

Parameters:: dir - Directory used for the package / distribution or single file.

Downloader - Interface in org.ysb33r.grolifant5.api.core.downloader

Interface for downloading a package or distribution and logging progress using internal Gradle mechanisms.

downloader(java.lang.String) - Method in ExecTools

Creates a new downloader for downloading packages / distributions.

DownloadFailedException - Class in org.ysb33r.grolifant5.api.errors

Failure to download an item.

DownloadFailedException() - Constructor in DownloadFailedException

downloadLocation(java.net.URI, java.io.File, java.lang.String, java.lang.String) - Method in Downloader

Returns information on where files are downloaded to.

DuplicateStateObjectException - Class in org.ysb33r.grolifant5.api.errors

A state object by the given name already exists.

DuplicateStateObjectException() - Constructor in DuplicateStateObjectException

E

emptyFileCollection() - Method in FileSystemOperations: Creates an empty file collection.
entrypoint(Closure<?>) - Method in AbstractExecSpec: Configures the native entrypoint.
entrypoint(Closure<?>) - Method in AbstractExecTask: Configures the native entrypoint.
entrypoint(Closure<?>) - Method in AbstractJvmExecSpec: Configures the entrypoint for the JVM executable
entrypoint(Closure<?>) - Method in AbstractJvmModelExecTask: Configures the entrypoint for the JVM executable
entrypoint(Closure<?>) - Method in Executable: Configures the native entrypoint.
entrypoint(Closure<?>) - Method in ForkedJvmExecutable: Configures the entrypoint for the JVM executable
environment(Map<String,?>) - Method in AbstractExecWrapperTask: Add environmental variables to be passed to the exe.
environment(java.lang.String, java.lang.Object) - Method in GrolifantProcessForkOptions
environment(Map<String, ?>) - Method in UnpackParameters: Add to the environment variables.
environmentVariable(java.lang.Object, boolean) - Method in ConfigurationPhaseOperations: Creates a provider to an environmental variable.
environmentVariable(java.lang.Object, boolean) - Method in GradleSysEnvProvider
environmentVariable(java.lang.Object, boolean) - Method in ProjectOperations: Creates a provider to an environmental variable.
environmentVariable(java.lang.Object, boolean) - Method in ProviderTools: Creates a provider to an environmental variable.
ERROR - Enum Constant in GrolifantProblemReporter.Severity
errorOutput(Closure<?>) - Method in ProcessExecutionSpec: Configure the process error output.
ExclusiveFileAccess - Class in org.ysb33r.grolifant5.api.core: Provides co-operative exclusive file access.
ExclusiveFileAccess(int, int) - Constructor in ExclusiveFileAccess: Create exclusive access guard and monitor.
exec() - Method in AbstractExecTask
exec() - Method in AbstractExecWrapperTask: The default implementation will build an execution specification and run it.
exec() - Method in AbstractJvmModelExecTask
exec() - Method in AbstractWrapperCacheBinaryTask
exec() - Method in AbstractWrapperGeneratorTask
exec(E) - Method in ConfigCacheSafeExecMethods: Executes an existing execution specification.
exec(Action<? super ExecSpec>) - Method in ConfigurationPhaseOperations: Executes the specified external process.
exec(org.ysb33r.grolifant5.api.core.ExecTools.OutputType, org.ysb33r.grolifant5.api.core.ExecTools.OutputType, E) - Method in ExecMethods: Controls what happens to the output of the execution specification.
exec(Action<? super ExecSpec>) - Method in ExecOperationsProxy: Executes the specified external process.
exec(org.ysb33r.grolifant5.api.core.ExecTools.OutputType, org.ysb33r.grolifant5.api.core.ExecTools.OutputType, Action<? super ExecSpec>) - Method in ExecTools: Executes the specified external process.
exec(E) - Method in JvmExecMethods: Executes an existing execution specification.
exec(Action<? super ExecSpec>) - Method in ProjectOperations: Executes the specified external process.
exec(org.ysb33r.grolifant5.api.core.ExecTools.OutputType, org.ysb33r.grolifant5.api.core.ExecTools.OutputType, Closure<?>) - Method in ProvisionedExecMethods: Controls what happens to the output of the execution specification.
exec(Action<E>) - Method in ProvisionedJvmExecMethods
ExecConfigurationException - Class in org.ysb33r.grolifant5.api.errors: An error occurred trying to configure an execution specification or a resolver for an external tool.
ExecConfigurationException() - Constructor in ExecConfigurationException
ExecMethods - Interface in org.ysb33r.grolifant5.api.core.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.grolifant5.api.core: Proxies the ExecOperations service that was added in Gradle 6.0, so that equivalent functionality can be provided in Gradle 4.0+
ExecOutput - Interface in org.ysb33r.grolifant5.api.core.runnable: This is modelled on the ExecOutput that was included as from Gradle 7.6.
execPatterns - Field in AbstractDistributionInstaller: Defined execution patterns.
execSpec() - Method in ExecTools: Returns something that looks like an ExecSpec.
ExecStreamContent - Interface in org.ysb33r.grolifant5.api.core.runnable: A handle to access content of the process' standard stream (the standard output of the standard error output).
ExecTools - Interface in org.ysb33r.grolifant5.api.core: Various tools to deal with non-JVM, out-of-process executables.
ExecTools.OutputType - Enum in org.ysb33r.grolifant5.api.core: Manage the output of external processes
execTools() - Method in ConfigCacheSafeOperations
execTools() - Method in GrolifantDefaultTask
Executable - Interface in org.ysb33r.grolifant5.api.core.runnable: A process that can be executed outside the JVM.
executable(java.lang.Object) - Method in GrolifantProcessForkOptions
executableByPath(java.lang.Object) - Method in AbstractBaseToolExtension: Locate an executable by a local path.
executableByPath(java.lang.Object) - Method in AbstractNativeToolchain
executableByPath(java.lang.Object) - Method in BaseToolLocation: Locate an executable by a local path.
executableBySearchPath(java.lang.Object) - Method in AbstractBaseToolExtension: Locate executable by searching the current environmental search path.
executableBySearchPath(java.lang.Object) - Method in AbstractNativeToolchain
executableBySearchPath(java.lang.Object) - Method in BaseToolLocation: Locate executable by searching the current environmental search path.
executableByVersion(java.lang.Object) - Method in AbstractNativeToolchain
executableByVersion(java.lang.Object) - Method in AbstractToolExtension: Locate an executable by version, probably downloading it if not local.
executableByVersion(java.lang.Object) - Method in ToolLocation: Locate an executable by version, probably downloading it if not local.
ExecutableCommand - Interface in org.ysb33r.grolifant5.api.core.runnable: Describes a command-based executable
ExecutableCommandSpec - Interface in org.ysb33r.grolifant5.api.core.executable: Specifies a command along with its arguments.
ExecutableDownloader - Interface in org.ysb33r.grolifant5.api.core.downloader: Interface for downloading an executable by version and returning the location.
ExecutableEntryPoint - Interface in org.ysb33r.grolifant5.api.core.executable: Describes the entrypoint for an external, but non-JVM, process.
ExecutableOperations - Interface in org.ysb33r.grolifant5.api.core.runnable: Additional operations that can be performed on something taht implemetns Executable.
executablePathOrNull() - Method in AbstractBaseToolExtension: If a path has been set instead of a version, resolve the path.
ExecutableScript - Interface in org.ysb33r.grolifant5.api.core.runnable: Describes a script-based executable.
executableSearchPathOrNull() - Method in AbstractBaseToolExtension: 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.
execute(org.gradle.api.file.CopySpec) - Method in ToolWrapper.1
execute() - Method in WorkerAppCmdline
ExecutionException - Class in org.ysb33r.grolifant5.api.errors: A failure occurred running or setting up an execution specification.
ExecutionException() - Constructor in ExecutionException
ExecutionMode - Enum in org.ysb33r.grolifant5.api.core.jvm: Method to execution an application on the JVM
EXTENSION_NAME - Field in GrolifantServicePlugin
extractFinalExtension(java.lang.String) - Method in AbstractDistributionInstaller: Extract the last extension in a file name.
EXTRAS_PARSER - Property in Version: Extract bits out of the extra section.
EXTRAS_WITH_SNAPSHOT_PARSER - Property in Version: Patterns for identifying extras which also contains a SNAPSHOT.

F

failNoExecConfig() - Method in AbstractBaseToolExtension

Call this when there is no preset way to local the executable.

file(java.lang.Object) - Method in FileSystemOperations

Converts a file-like object to a File instance with project context.

fileOrNull(java.lang.Object) - Method in FileSystemOperations

Similar to {

Link:: #file}, but does not throw an exception if the object is null or an empty provider.

files(Collection<?>) - Method in FileSystemOperations

Converts a file-like objects to File instances with project context.

filesDropNull(Collection<?>) - Method in FileSystemOperations

Converts a file-like objects to File instances with project context.

FileSystemOperations - Interface in org.ysb33r.grolifant5.api.core

Abstracts a number of file operations.

fileTree(java.lang.Object) - Method in ConfigurationPhaseOperations

Creates a new ConfigurableFileTree.

fileTree(java.lang.Object) - Method in FileSystemOperations

Obtain a file tree given a starting location

fileTree(java.lang.Object) - Method in ProjectOperations

Creates a new ConfigurableFileTree.

find(org.gradle.api.Project) - Method in ProjectOperations

Attempts to find the extension.

findAllInPath(java.lang.String) - Method in OperatingSystem

Find all files in system search path of a certain name.

findInPath(java.lang.String) - Method in OperatingSystem

Locates the given exe in the system path.

flatMap(Provider<T>, Transformer<? extends Provider<? extends S>,? super T>) - Method in ProviderTools

Allow flatMap functionality for providers even before Gradle 5.0.

ForkedJvmExecutable - Interface in org.ysb33r.grolifant5.api.core.runnable

A process that can be executed on a JVM

ForkedJvmScript - Interface in org.ysb33r.grolifant5.api.core.runnable

FORWARD_AND_CAPTURE - Enum Constant in ExecTools.OutputType

Forward output and capture it.

FORWARD - Enum Constant in ExecTools.OutputType

Forward output but do not capture it.

forward() - Method in OutputStreamSpec

Forwards the standard output from the running process to console except if running in quiet mode.

from(org.ysb33r.grolifant5.api.core.runnable.ConfigCacheSafeExecMethods) - Method in ConfigCacheSafeExecMethods

from(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Method in ConfigCacheSafeOperations

Creates an instance from another implementor of the ConfigCacheSafeOperations interface.

from(org.gradle.api.Project) - Method in ConfigurationPhaseOperations

Create an instance from an existing Project reference.

from(org.gradle.api.Project) - Method in ProjectOperations

fsOperations() - Method in ConfigCacheSafeOperations

fsOperations() - Method in GrolifantDefaultTask

G

get(java.lang.String, java.lang.String, org.ysb33r.grolifant5.api.core.PropertyResolveOrder) - Method in PropertyResolver

Gets a property using a specific resolve order

getAdditionalProperties() - Method in AbstractWrapperCacheBinaryTask

Returns additional properties to be added to the cached binary properties file.

getAllArgs() - Method in AbstractCmdlineArgumentSpec

All defined arguments, plus all arguments providers via the command-line argument providers.

getAllArgs() - Method in AllArgsProvider

All defined arguments, plus all arguments providers via the command-line argument providers.

getApplicationArguments() - Method in WorkerAppCmdlineParameters

getApplicationArguments() - Method in WorkerExecSpec

The list of all resovled application arguments.

getArch() - Method in OperatingSystem

Architecture underlying the operating system

getArchivePath() - Method in AbstractCloudGit

Calculates an archive path for the specific repository type.

getArchivePath() - Method in GitHubArchive

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.

getArchiveRootProvider() - Method in GitRepoArchiveDownloader

Returns the location which is the top or home folder for a distribution.

getArchiveUri() - Method in CloudGitDescriptor

Obtains the URI for the archive of the repository.

getArchiveUriProvider() - Method in CloudGitDescriptor

Obtains the URI for the archive of the repository.

getArchStr() - Method in OperatingSystem

getArgs() - Method in AbstractCmdlineArgumentSpec

Return list of arguments to the entrypoint.

getArgs() - Method in CmdlineArgumentSpec

Return list of arguments to the entrypoint.

getAsBytes() - Method in ExecStreamContent

Gets a provider for the standard stream's content that returns it as a byte array.

getAsText() - Method in ExecStreamContent

Gets a provider for the standard stream's content that returns it as a String.

getBaseRelativePath() - Method in GrolifantUnpacker.Parameters

Relative path below Gradle User Home to create cache for all versions of the distribution type.

getBaseRelativePath() - Method in UnpackParameters

Relative path below Gradle User Home to create cache for all versions of the distribution type.

getBaseStringForKey() - Method in GrolifantSecurePropertyServiceParameters

getBeginToken() - Method in AbstractWrapperGeneratorTask

If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the start token delimiter.

getBinaryLocationProvider() - Method in AbstractWrapperCacheBinaryTask

Obtains location of executable binary or script

getBinaryVersionProvider() - Method in AbstractWrapperCacheBinaryTask

Obtains version of binary or script

getBuildDir() - Method in ConfigurationPhaseOperations

Provider for the build directory.

getBuildDir() - Method in ProjectOperations

Provider for the build directory.

getByVersion(java.lang.String) - Method in ExecutableDownloader

Locates, and optionally downloads, an executable by version.

getCachedBinaryProperties() - Method in AbstractWrapperCacheBinaryTask

getChecksum() - Method in AbstractDistributionInstaller.2

getChecksum() - Method in CheckSumVerification

Returns the checksum in question.

getClasspath() - Method in ClasspathSpec

Get classpath as a FileCollection.

getCmd() - Method in AbstractCommandExecSpec

Get direct access to the CommandEntryPoint instance.

getCmd() - Method in AbstractCommandExecTask

Get direct access to the CommandEntryPoint instance.

getCmd() - Method in ExecutableCommand

Get direct access to the CommandEntryPoint instance.

getCmdline() - Method in JvmAppRunnerSpec

Direct access to the CmdlineArgumentSpec instance.

getCommand() - Method in CommandEntryPoint

Get the command.

getCommand() - Method in ExecutableCommandSpec

The command used in this specification as a String.

getCommandLineArgumentProviders() - Method in AbstractCmdlineArgumentSpec

Get current list of command-line argument providers.

getCommandLineArgumentProviders() - Method in CommandLineArgumentProviders

Get current list of command-line argument providers.

getCommandLineProcessors() - Method in AbstractExecSpec

getCommandLineProcessors() - Method in AppRunnerSpec

Provides direct access to the list of command-line processors.

getCommandLineProcessors() - Method in JvmAppRunnerSpec

Provides direct access to the list of command-line processors.

getConfigCacheSafeOperations() - Method in ConfigCacheSafeExecMethods

Grolifant's configuration cache-safe operations.

getConfigurationPhaseOperations() - Method in ProjectOperations

The ConfigurationPhaseOperations instance that this is wrapping.

getConfigurations() - Method in ConfigurationPhaseOperations

Tools to deal with Gradle configurations.

getConfigurations() - Method in ProjectOperations

Tools to deal with Gradle configurations.

getConsoleOutput() - Method in ConfigurationPhaseOperations

Console output mode

getConsoleOutput() - Method in ProjectOperations

Console output mode

getConsoleOutput() - Method in ProjectTools

Console output mode

getDestDirProvider() - Method in AbstractWrapperGeneratorTask

getDisplayName() - Method in GrolifantProblemReporter.ProblemGroup

getDisplayName() - Method in GrolifantProblemReporter.ProblemId

getDistFromCache(java.lang.String) - Method in AbstractDistributionInstaller

Creates a distribution if it does not exist already.

getDistFromSdkMan(java.lang.String) - Method in AbstractDistributionInstaller

Attempts to locate distribution in the list of SdkMan candidates.

getDistributionFile(java.lang.String, java.lang.String) - Method in AbstractDistributionInstaller

Locates a file within the distribution

getDistributionFile(java.lang.String, java.lang.String) - Method in DistributionInstaller

Locates a file within the distribution

getDistributionRoot(java.lang.String) - Method in AbstractDistributionInstaller

Returns the location which is the top or home folder for a distribution.

getDistributionRoot(java.lang.String) - Method in DistributionInstaller

Returns the location which is the top or home folder for a distribution.

getDownloader() - Method in AbstractNativeToolchain

Gets the downloader implementation.

getDownloader() - Method in AbstractToolExtension

Gets the downloader implementation.

getEnabled() - Method in JvmDebugOptions

Whether to attach a debug agent to the forked process.

getEndToken() - Method in AbstractWrapperGeneratorTask

If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the end token delimiter.

getEntrypoint() - Method in AbstractExecSpec

Access to the entrypoint

getEntrypoint() - Method in AbstractExecTask

Access to the entrypoint

getEntrypoint() - Method in AbstractJvmExecSpec

Get direct access to the JvmEntryPoint instance.

getEntrypoint() - Method in AbstractJvmModelExecTask

Get direct access to the JvmEntryPoint instance.

getEntrypoint() - Method in AppRunnerSpec

Access to the entrypoint

getEntrypoint() - Method in Executable

Access to the entrypoint

getEntrypoint() - Method in ForkedJvmExecutable

Get direct access to the JvmEntryPoint instance.

getEntrypoint() - Method in JvmAppRunnerSpec

Direct access to the JvmEntryPoint instance.

getEnvironment() - Method in GrolifantProcessForkOptions

getEnvironment() - Method in GrolifantUnpacker.Parameters

Customised environment to run under.

getEnvironment() - Method in UnpackParameters

Customised environment to run under.

getErrorOutput() - Method in ProcessExecutionSpec

The output stream configuration.

getExecSpec() - Method in AbstractExecWrapperTask

Access to the execution specification.

getExecTools() - Method in ConfigurationPhaseOperations

Tools to deal with out-of-process, non-JVM, executables.

getExecTools() - Method in ProjectOperations

Tools to deal with out-of-process, non-JVM, executables.

getExecutable() - Method in AbstractBaseToolExtension

A provider for a resolved executable.

getExecutable() - Method in AbstractNativeToolchain

getExecutable() - Method in BaseToolLocation

A provider for a resolved executable.

getExecutable() - Method in GrolifantProcessForkOptions

getExecutableLocation() - Method in AbstractExecWrapperTask

Location of executable

getExecutableNames(java.lang.String) - Method in OperatingSystem

getExecutableVersion() - Method in AbstractNativeToolchain

getExecutionSignature() - Method in AppRunnerSpec

A unique string which determines whether there were any changes.

getExecutionSignature() - Method in JvmAppRunnerSpec

A unique string which determines whether there were any changes.

getFile() - Method in ClassLocation

If the class is located on the filesystem or in a JAR this will be the location.

getFileCapture() - Method in OutputStreamSpec

Obtains the file capture lcoation if it has been set.

getForkOptions() - Method in JvmAppRunnerSpec

Direct access to the JavaForkOptionsWithEnvProvider instance.

getFromCache(java.lang.String, boolean, org.ysb33r.grolifant5.api.core.downloader.Downloader) - Method in ArtifactDownloader

Creates a distribution/file it it does not exist already.

getFromCache(java.net.URI, java.lang.String, java.lang.String) - Method in DependencyCache

Extract an artifact from cache.

getFsOperations() - Method in ConfigurationPhaseOperations

Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.

getFsOperations() - Method in ProjectOperations

Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.

getFullProjectPath() - Method in ConfigurationPhaseOperations

Get the full project path including the root project name in case of a multi-project.

getFullProjectPath() - Method in ProjectOperations

Get the full project path including the root project name in case of a multi-project.

getFullProjectPath() - Method in ProjectTools

Get the full project path including the root project name in case of a multi-project.

getGradleHomeDir() - Method in ConfigurationPhaseOperations

Gradle distribution home directory.

getGradleHomeDir() - Method in FileSystemOperations

Gradle distribution home directory.

getGradleHomeDir() - Method in ProjectOperations

Gradle distribution home directory.

getGradleLogLevel() - Method in ConfigurationPhaseOperations

Get the minimum log level for Gradle.

getGradleLogLevel() - Method in ProjectOperations

Get the minimum log level for Gradle.

getGradleLogLevel() - Method in ProjectTools

Get the minimum log level for Gradle.

getGradleUserHomeDir() - Method in ConfigurationPhaseOperations

Gradle user home directory.

getGradleUserHomeDir() - Method in FileSystemOperations

Gradle user home directory.

getGradleUserHomeDir() - Method in ProjectOperations

Gradle user home directory.

getGrolifantSecurePropertyService() - Method in GrolifantDefaultTask

getGroupProvider() - Method in ConfigurationPhaseOperations

Lazy-evaluated project group.

getGroupProvider() - Method in ProjectOperations

Lazy-evaluated project group.

getGroupProvider() - Method in ProjectTools

Lazy-evaluated project group.

getHomeVar() - Method in OperatingSystem

The name of the environment variable that keeps the home directory.

getIdentifier() - Method in AbstractCloudGit

Returns an identifier of an instance in the repository.

getIdentifierProvider() - Method in AbstractCloudGit

Returns an identifier of an instance in the repository.

getInferModulePath() - Method in ModularitySpec

Whether module path should be inferred.

getJavaExecSpec() - Method in WorkerExecSpec

The configured JavaExecSpec.

getJvm() - Method in AbstractJvmExecSpec

Direct access to the JavaForkOptionsWithEnvProvider instance.

getJvm() - Method in AbstractJvmModelExecTask

Direct access to the JavaForkOptionsWithEnvProvider instance.

getJvm() - Method in ForkedJvmExecutable

Direct access to the JavaForkOptionsWithEnvProvider instance.

getJvmAppRunnerSpec() - Method in AbstractJvmExecSpec

getJvmEntrypoint() - Method in WorkerExecSpec

The JVM entry point.

getJvmExecSpec() - Method in AbstractJvmModelExecTask

getJvmTools() - Method in ConfigurationPhaseOperations

Tools for dealing for JVM/Java operations.

getJvmTools() - Method in ProjectOperations

Tools for dealing for JVM/Java operations.

getLocationPropertiesFile() - Method in AbstractWrapperCacheBinaryTask

getMainClass() - Method in MainClassSpec

Get the main class name.

getMainModule() - Method in ModularitySpec

Provider to the main module name.

getName() - Method in BaseScriptDefinition

Name of script.

getName() - Method in BaseScriptSpec

Provider to the name of a script.

getName() - Method in GrolifantProblemReporter.ProblemGroup

getName() - Method in GrolifantProblemReporter.ProblemId

getName() - Method in OperatingSystem

getName() - Method in ScriptDefinition

getNameOrPath() - Method in ScriptDefinition

getNameOrPath() - Method in ScriptSpec

Provider to either a script name or a string-based representation of the file path where the script can be found.

getNativeExecSpec() - Method in AbstractExecTask

The actual implementation of the execution specification.

getOfflineProvider() - Method in ProjectTools

A value that indicates whether Gradle is run in offline mode or not.

getOrganisation() - Method in CloudGitDescriptor

Organisation on Git cloud service

getOrganisationProvider() - Method in AbstractCloudGit

Organisation on Git cloud service

getOrganisationProvider() - Method in CloudGitDescriptor

Organisation on Git cloud service

getOutput() - Method in ProcessExecutionSpec

The output stream configuration.

getOutputType() - Method in OutputStreamSpec

Get the output type that corresponds to the current configuration.

getPath() - Method in OperatingSystem

List of system search paths

getPath() - Method in ScriptDefinition

getPath() - Method in ScriptSpec

Provider to the path of a script.

getPathByVersion(java.lang.String) - Method in ExecutableDownloader

Locates, and optionally downloads, an executable by version.

getPathSeparator() - Method in OperatingSystem

The character used to separate elements in a system search path

getPathVar() - Method in OperatingSystem

The name of the environment variable that keeps the system path.

getPort() - Method in JvmDebugOptions

The debug port.

getPreArgs() - Method in AbstractCmdlineArgumentSpec

A provider to arguments that will be inserted before any supplied arguments.

getPreArgs() - Method in AllArgsProvider

A provider to arguments that will be inserted before any supplied arguments.

getPreArgs() - Method in BaseScriptDefinition

A provider to arguments that will be inserted before any supplied arguments.

getPreArgs() - Method in ScriptDefinition

A provider to arguments that will be inserted before any supplied arguments.

getProblemGroup() - Method in GrolifantProblemReporter.ProblemId

getProblemReporter() - Method in ConfigurationPhaseOperations

Access to the problem reporter.

getProblemReporter() - Method in ProjectOperations

Access to the problem reporter.

getProcess() - Method in AbstractExecSpec

Access to the process specification.

getProcess() - Method in AbstractExecTask

Access to the process specification.

getProcess() - Method in AbstractJvmExecSpec

Get direct access to the ProcessExecutionSpec instance.

getProcess() - Method in AbstractJvmModelExecTask

Get direct access to the ProcessExecutionSpec instance.

getProcess() - Method in AppRunnerSpec

Access to the process specification.

getProcess() - Method in Executable

Access to the process specification.

getProcess() - Method in ForkedJvmExecutable

Get direct access to the ProcessExecutionSpec instance.

getProcess() - Method in JvmAppRunnerSpec

Direct access to the ProcessExecutionSpec instance.

getProjectCacheDir() - Method in ConfigurationPhaseOperations

Returns the project cache directory for the given project.

getProjectCacheDir() - Method in FileSystemOperations

Returns the project's local cache directory

getProjectCacheDir() - Method in ProjectOperations

Returns the project cache directory for the given project.

getProjectDescriptionProvider() - Method in ProjectTools

Description of the project.

getProjectDir() - Method in ConfigurationPhaseOperations

Returns the project directory.

getProjectDir() - Method in FileSystemOperations

Returns the project directory.

getProjectDir() - Method in ProjectOperations

Returns the project directory.

getProjectExtension() - Method in CombinedProjectTaskExtensionBase

If this extension is attached to a task, this point to the global project extension if it exists, other null.

getProjectName() - Method in ConfigurationPhaseOperations

The project name

getProjectName() - Method in ProjectOperations

The project name

getProjectNameProvider() - Method in ProjectTools

Name of the project.

getProjectOperations() - Method in CombinedProjectTaskExtensionBase

ProjectOperations instance that the extension can use.

getProjectOperations() - Method in ProvisionedJvmExecMethods

Grolifant's configuration cache-safe operations.

getProjectPath() - Method in ConfigurationPhaseOperations

Get project path.

getProjectPath() - Method in ProjectOperations

Get project path.

getProjectRootDir() - Method in ConfigurationPhaseOperations

Returns the root directory of the project.

getProjectRootDir() - Method in FileSystemOperations

The project root dir.

getProjectRootDir() - Method in ProjectOperations

Returns the root directory of the project.

getProjectTools() - Method in ConfigurationPhaseOperations

Tools to deal with project & configuration specifics down to Gradle 4.0.

getProjectTools() - Method in ProjectOperations

Tools to deal with project & configuration specifics down to Gradle 4.0.

getPropertiesDescription() - Method in AbstractWrapperCacheBinaryTask

Obtains a description to be added to the cached binary properties file.

getProviders() - Method in ConfigurationPhaseOperations

A reference to the provider factory.

getProviders() - Method in ProjectOperations

A reference to the provider factory.

getProviderTools() - Method in ConfigurationPhaseOperations

Tools to deal with provider down to Gradle 4.0.

getProviderTools() - Method in ProjectOperations

Tools to deal with provider down to Gradle 4.0.

getRepository() - Method in CloudGitDescriptor

Repository on Git cloud service

getRepositoryProvider() - Method in AbstractCloudGit

Repository on Git cloud service

getRepositoryProvider() - Method in CloudGitDescriptor

Repository on Git cloud service

getRepositoryTools() - Method in ConfigurationPhaseOperations

Tools for dealing with repositories.

getRepositoryTools() - Method in ProjectOperations

Tools for dealing with repositories.

getResult() - Method in ExecOutput

Returns a provider of the execution result.

getRunnerSpec() - Method in AbstractExecSpec

Access to the runner specification.

getRunnerSpec() - Method in AbstractExecTask

Access to the runner specification.

getRunnerSpec() - Method in AbstractJvmExecSpec

Get direct access to the CmdlineArgumentSpec instance.

getRunnerSpec() - Method in AbstractJvmModelExecTask

Get direct access to the CmdlineArgumentSpec instance.

getRunnerSpec() - Method in AppRunnerSpec

Access to the runner specification.

getRunnerSpec() - Method in Executable

Access to the runner specification.

getRunnerSpec() - Method in ForkedJvmExecutable

Get direct access to the CmdlineArgumentSpec instance.

getRuntime() - Method in ClassLocation

If the class is located in a runtime module

getScript() - Method in AbstractJvmScriptExecSpec

Get direct access to the ScriptSpec instance.

getScript() - Method in AbstractJvmScriptExecTask

Get direct access to the ScriptSpec instance.

getScript() - Method in ForkedJvmScript

Get direct access to the ScriptSpec instance.

getScriptDefinition() - Method in AbstractJvmScriptExecSpec

Returns the instance of the script definition.

getSdkManCandidateName() - Method in AbstractDistributionInstaller

SDKman candidate name for distribution.

getSdkManCandidateName() - Method in DistributionInstaller

SDKman candidate name for distribution.

getSealedObject() - Method in SimpleSecureString

Returns the encrypted object.

getServer() - Method in JvmDebugOptions

Whether a socket-attach or a socket-listen type of debugger is expected.

getSharedLibraryName(java.lang.String) - Method in OperatingSystem

Returns OS-specific shared library name

getSharedLibrarySuffix() - Method in OperatingSystem

OS-dependent string that is used to suffix to shared libraries

getSignature() - Method in GrolifantSimpleJavaForkOptions

A signature that can be used as an input to a task such as JavaExec to help with up-to-date checks.

getSingleFile(java.lang.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

getStandardError() - Method in ExecOutput

Gets a handle to the content of the process' standard error output.

getStandardOutput() - Method in ExecOutput

Gets a handle to the content of the process' standard output.

getStaticLibraryName(java.lang.String) - Method in OperatingSystem

Returns OS-specific static library name

getStaticLibrarySuffix() - Method in OperatingSystem

OS-dependent string that is used to suffix to static libraries

getStringTools() - Method in ConfigurationPhaseOperations

Tools for dealing with conversions of various objects into string or lists of strings.

getStringTools() - Method in ProjectOperations

Tools for dealing with conversions of various objects into string or lists of strings.

getSuspend() - Method in JvmDebugOptions

Whether the forked process should be suspended until the connection to the debugger is established.

getTask() - Method in CombinedProjectTaskExtensionBase

Task this extension is attached to.

getTaskOperations() - Method in AbstractExecSpec

getTasks() - Method in ConfigurationPhaseOperations

Utilities for working with tasks in a consistent manner across Gradle versions.

getTasks() - Method in ProjectOperations

Utilities for working with tasks in a consistent manner across Gradle versions.

getTokenValuesAsMap() - Method in AbstractWrapperGeneratorTask

If the default of org.apache.tools.ant.filters.ReplaceTokens is used, this method will return the collection of tokens.

getToolExtension() - Method in AbstractExecWrapperWithExtensionTask

Access to the task extension of the tool type.

getVersion() - Method in OperatingSystem

getVersionProvider() - Method in ConfigurationPhaseOperations

Lazy-evaluated project version.

getVersionProvider() - Method in ProjectOperations

Lazy-evaluated project version.

getVersionProvider() - Method in ProjectTools

Lazy-evaluated project version.

getWindowsExtensionSearchOrder() - Method in AbstractBaseToolExtension

The order in which extensions will be checked for locating an executable on Windows.

getWindowsExtensionSearchOrder() - Method in AbstractNativeToolchain

getWindowsExtensionSearchOrder() - Method in BaseToolLocation

The order in which extensions will be checked for locating an executable on Windows.

getWorkingDir() - Method in GrolifantProcessForkOptions

getWrapperDestinationDirProvider() - Method in AbstractWrapperGeneratorTask

Directory for writing wrapper files to.

GitHubArchive - Class in org.ysb33r.grolifant5.api.core.git

Describes a GitHub archive.

GitHubArchive(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in GitHubArchive

GitLabArchive - Class in org.ysb33r.grolifant5.api.core.git

Describes a Gitlab archive.

GitLabArchive(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in GitLabArchive

GitRepoArchiveDownloader - Class in org.ysb33r.grolifant5.api.core.git

Downloads an archive from a Git repository.

GitRepoArchiveDownloader.1 - Class in org.ysb33r.grolifant5.api.core.git

GitRepoArchiveDownloader.1() - Constructor in GitRepoArchiveDownloader.1

GitRepoArchiveDownloader.2 - Class in org.ysb33r.grolifant5.api.core.git

GitRepoArchiveDownloader.2() - Constructor in GitRepoArchiveDownloader.2

GitRepoArchiveDownloader(org.ysb33r.grolifant5.api.core.git.CloudGitDescriptor, org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in GitRepoArchiveDownloader

Download archive from Git Cloud provider.

gradleProperty(java.lang.Object, boolean) - Method in ConfigurationPhaseOperations

Creates a provider to a project property.

gradleProperty(java.lang.Object, boolean) - Method in GradleSysEnvProvider

gradleProperty(java.lang.Object, boolean) - Method in ProjectOperations

Creates a provider to a project property.

gradleProperty(java.lang.Object, boolean) - Method in ProviderTools

Creates a provider to a project property.

GradleSysEnvProvider - Interface in org.ysb33r.grolifant5.api.core

An proxy to provide system properties, project properties and environmental variables as providers.

GrolifantDefaultTask - Class in org.ysb33r.grolifant5.api.core.runnable

A base task that can provide configuration-cache safe access to various Grolifant helpers.

GrolifantDefaultTask() - Constructor in GrolifantDefaultTask

GrolifantError - Interface in org.ysb33r.grolifant5.api.errors

A token interface for exception arising out of Grolifant library.

GrolifantProblemReporter - Interface in org.ysb33r.grolifant5.api.core

The Grolifant Problem Reporter.

GrolifantProblemReporter.ProblemGroup - Class in org.ysb33r.grolifant5.api.core

Defines a problem group.

GrolifantProblemReporter.ProblemId - Class in org.ysb33r.grolifant5.api.core

Defines a problem id.

GrolifantProblemReporter.ProblemSpec - Interface in org.ysb33r.grolifant5.api.core

A configurable problem specification.

GrolifantProblemReporter.Severity - Enum in org.ysb33r.grolifant5.api.core

Severity.

GrolifantProcessForkOptions - Interface in org.ysb33r.grolifant5.api.core

A workaround for ProcessForkOptions to keep compatibility across Gradle versions.

GrolifantSecurePropertyService - Class in org.ysb33r.grolifant5.api.core.services

A service that can semi-secure credential strings whilst held in memory.

GrolifantSecurePropertyService() - Constructor in GrolifantSecurePropertyService

GrolifantSecurePropertyServiceParameters - Interface in org.ysb33r.grolifant5.api.core.services

Authors:: Schalk W.

GrolifantServicePlugin - Class in org.ysb33r.grolifant5.api.core.plugins

Adds an extension called grolifantOps and a service called grolifant-secure-property-service.

GrolifantServicePlugin.ProjectVersionEvaluator - Class in org.ysb33r.grolifant5.api.core.plugins

GrolifantServicePlugin() - Constructor in GrolifantServicePlugin

GrolifantSimpleJavaForkOptions - Interface in org.ysb33r.grolifant5.api.core.jvm

An extended interface that can be used to update a Gradlle API JavaForkOptions

GrolifantSimpleSetJavaForkOptions - Interface in org.ysb33r.grolifant5.api.core.jvm

An interface to set the most import Java fork options without relying on the actual Gradle API JavaForkOptions.

GrolifantUnpacker - Interface in org.ysb33r.grolifant5.spi.unpackers

The interface an unpacker has to implement.

GrolifantUnpacker.Engine - Interface in org.ysb33r.grolifant5.spi.unpackers

Operations that an unpacking engine can perform.

GrolifantUnpacker.Parameters - Interface in org.ysb33r.grolifant5.spi.unpackers

Configuration parameters for an engine.

GrolifantVersion - Class in org.ysb33r.grolifant5.api.core

Holds the Grolifant version.

GrolifantVersion() - Constructor in GrolifantVersion

gzipResource(java.lang.Object) - Method in ConfigurationPhaseOperations

Creates resource that points to a gzip compressed file at the given path.

gzipResource(java.lang.Object) - Method in FileSystemOperations

Creates resource that points to a gzip compressed file at the given path.

gzipResource(java.lang.Object) - Method in ProjectOperations

Creates resource that points to a gzip compressed file at the given path.

H

hashUri(java.net.URI) - Method in StringTools: Creates a SHA-256 hash of a URI.

I

IGNORE_EMPTY_DIRECTORIES - Enum Constant in TaskInputFileOptions: Ignore directories during up-to-date checks and build cache key calculations.
ignoreEmptyDirectories(org.gradle.api.tasks.TaskInputs, java.lang.Object) - Method in TaskTools: This is similar to putting both a SkipWhenEmpty and a org.gradle.api.tasks.IgnoreEmptyDirectories annotation on a property, but it deals with both backwards and forward compatibility around Gradle 6.8.
INITIAL_PARSER - Property in Version: The initial parse is used to extract major, minor, patch and any extras.
inputFiles(org.gradle.api.tasks.TaskInputs, java.lang.Object, org.gradle.api.tasks.PathSensitivity, org.ysb33r.grolifant5.api.core.TaskInputFileOptions) - Method in TaskTools: Configure a collection of files as a task input.
IS_MACOSX - Field in AbstractDistributionInstaller
IS_WINDOWS - Field in AbstractDistributionInstaller
isConfigurationCacheEnabled() - Method in ConfigurationPhaseOperations: Whether configuration cache is enabled for a build.
isConfigurationCacheEnabled() - Method in ProjectOperations: Whether configuration cache is enabled for a build.
isConfigurationCacheEnabled() - Method in ProjectTools: Whether configuration cache is enabled for a build.
isErrorOutputForwarded() - Method in ProcessOutputProcessor: Whether process error output is forwarded to the console.
isFreeBSD() - Method in OperatingSystem: Check is this is FreeBSD
isIgnoreExitValue() - Method in ProcessExecutionSpec: Tells whether a non-zero exit value is ignored, or an exception thrown.
isLinux() - Method in OperatingSystem: Check is this is a Linux flavour
isMacOsX() - Method in OperatingSystem: Check is this is Apple Mac OS X
isMultiProject() - Method in ProjectTools: Whether the setup is a multi-project or a single project.
isNetBSD() - Method in OperatingSystem: Check is this is NetBSD
isOffline() - Method in ConfigurationPhaseOperations: Whether Gradle is operating in offline mode.
isOffline() - Method in ProjectOperations: Whether Gradle is operating in offline mode.
isOutputForwarded() - Method in ProcessOutputProcessor: Whether process output is forwarded to the console.
isRefreshDependencies() - Method in ConfigurationPhaseOperations: Whether dependencies should be refreshed.
isRefreshDependencies() - Method in ProjectOperations: Whether dependencies should be refreshed.
isRefreshDependencies() - Method in ProjectTools: Whether dependencies should be refreshed.
isRerunTasks() - Method in ConfigurationPhaseOperations: Whether tasks should be re-ruin
isRerunTasks() - Method in ProjectOperations: Whether tasks should be re-ruin
isRerunTasks() - Method in ProjectTools: Whether tasks should be re-ruin
isRoot() - Method in ConfigurationPhaseOperations: Whether current project is the root project.
isRoot() - Method in ProjectOperations: Whether current project is the root project.
isRootProject() - Method in ProjectTools: Whether the current project is the root project.
isSolaris() - Method in OperatingSystem: Check is this is a Solaris flavour
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

J

JAVA_EXEC - Enum Constant in ExecutionMode

javaexec(Action<? super JavaExecSpec>) - Method in ConfigurationPhaseOperations

Executes the specified external java process.

javaexec(Action<? super JavaExecSpec>) - Method in ExecOperationsProxy

Executes the specified external java process.

javaexec(org.ysb33r.grolifant5.api.core.ExecTools.OutputType, org.ysb33r.grolifant5.api.core.ExecTools.OutputType, Action<? super JavaExecSpec>) - Method in ExecTools

Executes the specified external process.

javaexec(Action<? super JavaExecSpec>) - Method in ProjectOperations

Executes the specified external java process.

javaExecSpec() - Method in JvmTools

Creates a JavaExecSpec.

javaForkOptions() - Method in JvmTools

Creates a {

Link:: JavaForkOptions}.

JavaForkOptionsWithEnvProvider - Interface in org.ysb33r.grolifant5.api.core.jvm

Adds environment providers to JavaForkOptions.

jvm(Closure<?>) - Method in AbstractJvmExecSpec

Configures a JVM that will be forked.

jvm(Closure<?>) - Method in AbstractJvmModelExecTask

Configures a JVM that will be forked.

jvm(Closure<?>) - Method in ForkedJvmExecutable

Configures a JVM that will be forked.

JvmAppRunnerSpec - Interface in org.ysb33r.grolifant5.api.core.jvm

A specification to something that can be executed on the JVM and which be populated with various fork options for Java and in addition, can then be used to copy to other methods in the Gradle API that provides a JavaForkOptions in the parameters.

jvmAppRunnerSpec() - Method in JvmTools

Creates a JvmAppRunnerSpec.

JvmDebugOptions - Interface in org.ysb33r.grolifant5.api.core.jvm

JvmEntryPoint - Interface in org.ysb33r.grolifant5.api.core.jvm

Configures a class name or module.

JvmExecMethods - Interface in org.ysb33r.grolifant5.api.core.runnable

Adds interface to a AbstractToolExtension implementation, so that the spirit of the original javaexec project extension can be maintained for a specific tool.

JvmExecutionModel - Interface in org.ysb33r.grolifant5.api.core.runnable

Models for executing JVMN processes.

JvmTools - Interface in org.ysb33r.grolifant5.api.core

Tools for creating various JVM/Java utility objects.

jvmTools() - Method in ConfigCacheSafeOperations

jvmTools() - Method in GrolifantDefaultTask

K

KEBAB_CASE - Enum Constant in CaseFormats: Hyphenated variable naming convention, e.g., "lower-hyphen".

L

LEGACY_EXTENSION_NAME - Field in GrolifantServicePlugin
LegacyLevel - Class in org.ysb33r.grolifant5.api.core: Internal used enumeration to help with logic with specific Gradle version differences.
LegacyLevel() - Constructor in LegacyLevel
lineInFileLocation(java.lang.String, int, int, int) - Method in GrolifantProblemReporter.ProblemSpec: Declares that this problem is in a file with on a line at a certain position.
listDirs(java.io.File) - Method in AbstractDistributionInstaller: Provides a list of directories below an unpacked distribution
listDirs(java.io.File) - Method in FileSystemOperations: Provides a list of directories below another directory
listProperty(Class<T>, Iterator<? extends T>) - Method in ProviderTools: Creates a ListProperty instance and initialises it from the supplied default values
loadPropertiesFromResource(java.lang.String, java.lang.ClassLoader) - Method in FileSystemOperations: Loads properties from a resource file.
loadPropertiesFromResource(java.lang.String) - Method in ResourceUtils: Loads properties from a resource file.
loadTextFromResource(java.lang.String) - Method in ResourceUtils: Loads a resource text file into memory.
loadTextFromResource(java.lang.String) - Method in StringTools: Loads text from a resource file.
locateDistributionInCustomLocation(java.lang.String) - Method in DistributionInstaller: Provide alternative means to look for distributions.
log(java.lang.String) - Method in BaseProgressLogger: Sends a progress message.
logProgress(java.lang.String) - Method in Downloader: Logs a progress message.
LOWER_CAMEL - Enum Constant in CaseFormats: Java variable naming convention, e.g., "lowerCamel".
LOWER_DOTTED - Enum Constant in CaseFormats: Dotted as in Gradle and system properties.

M

MainClassSpec - Interface in org.ysb33r.grolifant5.api.core.jvm: Defines a JVM main class.
major - Property in Version: The major version of the version.
major - Property in Version.Parts
makeByteArray(java.lang.Object) - Method in StringTools: Converts a source to a byte array.
makeByteArrayOrNull(java.lang.Object) - Method in StringTools: Converts a source to a byte array.
mapProperty(java.lang.Class<K>, java.lang.Class<V>) - Method in ProviderTools: Creates a MapProperty instance
markerFile - Property in DownloadedLocalFile
MAX_VALUE - Field in CaseFormats
MAX_VALUE - Field in ExecutionMode
MAX_VALUE - Field in TaskInputFileOptions
MAX_VALUE - Field in WorkerIsolation
maybeCreateExtension(org.gradle.api.Project) - Method in ProjectOperations: Creates a grolifant extension if it does not exist.
milestone - Property in Version: Whether the version is a milestone.
milestone - Property in Version.Parts
milestoneSequence - Property in Version
MIN_VALUE - Field in CaseFormats
MIN_VALUE - Field in ExecutionMode
MIN_VALUE - Field in TaskInputFileOptions
MIN_VALUE - Field in WorkerIsolation
minor - Property in Version: The minor part of the version.
minor - Property in Version.Parts
ModularitySpec - Interface in org.ysb33r.grolifant5.api.core.jvm: Handles modularity specification.

N

name - Property in AbstractCloudGit
name - Property in CmdLineArgumentSpecEntry
named(java.lang.String, Class<T>, Action<T>) - Method in TaskTools: Configures a task, preferably in a lazy-manner.
needsSpecificGrolifantLibrary(java.lang.String) - Method in NotSupportedException
newInstance(Class<? extends T>, java.lang.Object) - Method in ProviderTools: Shortcut for creating a new instance of an object.
next() - Method in CaseFormats
next() - Method in ExecutionMode
next() - Method in TaskInputFileOptions
next() - Method in WorkerIsolation
noGlobalExecSearch - Field in AbstractBaseToolExtension
noOutput() - Method in OutputStreamSpec: Do not forward or capture output.
noProjectExtension() - Method in AbstractBaseToolExtension: Pass to the task constructor when no project extension will be available or required.
NORMALIZE_LINE_ENDINGS - Enum Constant in TaskInputFileOptions: Normalize line endings in text files during up-to-date checks and build cache key calculations
NotSupportedException - Class in org.ysb33r.grolifant5.api.errors: Feature is not supported on this version of Gradle.
NotSupportedException() - Constructor in NotSupportedException

O

of(org.ysb33r.grolifant5.api.core.jvm.worker.WorkerIsolation) - Method in ExecutionMode

Construct an execution mode from a worker isolation mode.

of(java.lang.String, java.lang.String) - Method in GrolifantProblemReporter.ProblemGroup

of(java.lang.String, java.lang.String, java.lang.String, java.lang.String) - Method in GrolifantProblemReporter.ProblemId

of(java.lang.String) - Method in LegacyLevel

Parameters:: gradleVersion - A given Gradle version

of(java.lang.String, Function<String, Parts>) - Method in Version

Creates a new version instance from a parse-able string using a custom parser

offsetInFileLocation(java.lang.String, int, int) - Method in GrolifantProblemReporter.ProblemSpec

Declares that this problem is in a file at a certain global position with a given length.

onlyIf(org.gradle.api.Task, java.lang.String, Spec<? super Task>) - Method in TaskTools

Allows the onlyIf reason structure to be used backwards on Gradle <7.6.

OperatingSystem - Interface in org.ysb33r.grolifant5.api.core

Operating system information.

OperatingSystem.Arch - Enum in org.ysb33r.grolifant5.api.core

Enumeration representing common hardware-operating system architectures.

OPTIONAL - Enum Constant in TaskInputFileOptions

Whether the property is optional.

order - Property in CmdLineArgumentSpecEntry

order(org.ysb33r.grolifant5.api.core.PropertyResolveOrder) - Method in PropertyResolver

Change the existing property order

orElse(Provider<T>, Provider<? extends T>) - Method in ProviderTools

Allow orElse functionality prior to Gradle 5.6.

OUT_OF_PROCESS - Enum Constant in ExecutionMode

OUT_OF_PROCESS - Enum Constant in WorkerIsolation

output(Closure<?>) - Method in ProcessExecutionSpec

Configure the process output.

OutputStreamSpec - Interface in org.ysb33r.grolifant5.api.core.executable

Describes how output and output need needs to be managed for an external process.

P

pack(java.lang.String) - Method in GrolifantSecurePropertyService

packageNameFromUri(java.net.URI) - Method in StringTools

Get final package or directory name from a URI

PackageUnpacker - Interface in org.ysb33r.grolifant5.api.core.downloader

Interface for unpacking an archived or compressed package.

ParseException(java.lang.String, java.lang.Throwable) - Constructor in Version.ParseException

parseVersionFromOutput(Iterable<String>, java.io.File, Function<String,String>, Action<ExecSpec>) - Method in ExecTools

Simplifies running an executable to obtain a version.

password - Property in SimplePasswordCredentials

password - Property in SimpleRepositoryCredentials

patch - Property in Version

The patch part of the version.

patch - Property in Version.Parts

patternize(Collection<?>) - Method in StringTools

Converts a collection of most things to a list of regex patterns.

patternizeDropNull(Collection<?>) - Method in StringTools

Like patternize, but drops any nulls, or empty instances of Provider and java.util.Optional.

patternizeOrNull(java.lang.Object) - Method in StringTools

Like patternize, but returns null rather than throwing an exception, when item is null, an empty {

Link:: Provider} or an empty java.util.Optional.

PostDownloadProcessor - Interface in org.ysb33r.grolifant5.api.core.artifacts

Processes a file post-download.

POWERPC - Enum Constant in OperatingSystem.Arch

PowerPC architecture.

PRE_10_0 - Field in LegacyLevel

Since:: 5.3

PRE_4_10 - Field in LegacyLevel

PRE_4_1 - Field in LegacyLevel

PRE_4_2 - Field in LegacyLevel

PRE_4_3 - Field in LegacyLevel

PRE_4_5 - Field in LegacyLevel

PRE_4_6 - Field in LegacyLevel

PRE_4_7 - 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_2 - Field in LegacyLevel

PRE_5_5 - Field in LegacyLevel

PRE_5_6 - Field in LegacyLevel

PRE_6_0 - Field in LegacyLevel

PRE_6_1 - Field in LegacyLevel

PRE_6_4 - Field in LegacyLevel

PRE_6_5 - Field in LegacyLevel

PRE_6_6 - Field in LegacyLevel

PRE_6_8 - Field in LegacyLevel

PRE_7_0 - Field in LegacyLevel

PRE_7_1 - Field in LegacyLevel

PRE_7_2 - Field in LegacyLevel

PRE_7_3 - Field in LegacyLevel

PRE_7_4 - Field in LegacyLevel

Since:: 5.0

PRE_7_5 - Field in LegacyLevel

Since:: 5.0

PRE_7_6 - Field in LegacyLevel

PRE_8_0 - Field in LegacyLevel

PRE_8_10 - Field in LegacyLevel

Since:: 4.0

PRE_8_11 - Field in LegacyLevel

Since:: 5.0

PRE_8_12 - Field in LegacyLevel

Since:: 5.3

PRE_8_13 - Field in LegacyLevel

Since:: 5.3

PRE_8_14 - Field in LegacyLevel

Since:: 5.3

PRE_8_1 - Field in LegacyLevel

PRE_8_2 - Field in LegacyLevel

Since:: 2.2

PRE_8_3 - Field in LegacyLevel

Since:: 2.2

PRE_8_4 - Field in LegacyLevel

Since:: 2.2

PRE_8_5 - Field in LegacyLevel

Since:: 2.2

PRE_8_6 - Field in LegacyLevel

Since:: 2.2

PRE_8_7 - Field in LegacyLevel

Since:: 3.0

PRE_8_8 - Field in LegacyLevel

Since:: 4.0

PRE_8_9 - Field in LegacyLevel

Since:: 4.0

PRE_9_0 - Field in LegacyLevel

Since:: 5.0

PRE_9_1 - Field in LegacyLevel

Since:: 5.3

PRE_9_2 - Field in LegacyLevel

Since:: 5.3

PRE_9_3 - Field in LegacyLevel

Since:: 5.3

preventExecutionMode(org.ysb33r.grolifant5.api.core.jvm.ExecutionMode, java.lang.String) - Method in AbstractJvmModelExecTask

Prevents a specific execution mode from being set.

previous() - Method in CaseFormats

previous() - Method in ExecutionMode

previous() - Method in TaskInputFileOptions

previous() - Method in WorkerIsolation

problemReporter() - Method in ConfigCacheSafeOperations

Access to GrolifantProblemReporter instance that is specific to the current Gradle version.

problemReporter() - Method in GrolifantDefaultTask

process(Closure<?>) - Method in AbstractExecSpec