Index (grolifant-compat3 1.1.0-alpha.3 API)

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

A

AbstractCacheBinaryTask - Class in org.ysb33r.grolifant.api.script: Base class for tasks that can cache arbitrary binaries.
AbstractCacheBinaryTask(String) - Constructor in AbstractCacheBinaryTask
AbstractCloudGit - Class in org.ysb33r.grolifant.api.git: Base class for implementing common functionality for GitLab & GitHub
AbstractCloudGit(String, String) - Constructor in AbstractCloudGit
AbstractCombinedProjectTaskExtension - Class in org.ysb33r.grolifant.api: Base class for an extension that can both be used on a project or a task.
AbstractCombinedProjectTaskExtension(Task, String) - Constructor in AbstractCombinedProjectTaskExtension: Attach this extension to a task
AbstractCommandExecSpec - Class in org.ysb33r.grolifant.api.exec: Tool execution specification aimed at command-line tools which takes a command as one of the arguments.
AbstractCommandExecSpec(Project, ExternalExecutable) - Constructor in AbstractCommandExecSpec: Construct class and attach it to specific project.
AbstractCommandExecTask - Class in org.ysb33r.grolifant.api.exec: A abstract task type for executing binaries that take a command as well as a set of command arguments.
AbstractDistributionInstaller - Class in org.ysb33r.grolifant.api: Common functionality to be able to download a SDK and use it within Gradle
AbstractExecSpec - Class in org.ysb33r.grolifant.api.exec: Abstract base class that implements BaseExecSpec.
AbstractExecSpec(Project) - Constructor in AbstractExecSpec
AbstractExecWrapperTask - Class in org.ysb33r.grolifant.api.exec: Base task class to wrap external tool executions without exposing command-line parameters directly.
AbstractExecWrapperTask() - Constructor in AbstractExecWrapperTask
AbstractScriptExecSpec - Class in org.ysb33r.grolifant.api.exec: Tool execution specification aimed at script-line tools which takes a script as one of the arguments.
AbstractScriptExecSpec(Project, ExternalExecutable) - Constructor in AbstractScriptExecSpec: Construct class and attach it to specific project.
AbstractScriptExecTask - Class in org.ysb33r.grolifant.api.exec: A abstract task type for executing binaries that take a command as well as a set of command arguments.
AbstractScriptWrapperTask - Class in org.ysb33r.grolifant.api.script: @deprecated Useorg.ysb33r.grolifant.api.v4.wrapper.script.AbstractScriptWrapperTask instead.
AbstractScriptWrapperTask() - Constructor in AbstractScriptWrapperTask
AbstractToolExecSpec - Class in org.ysb33r.grolifant.api.exec: A base class to aid plugin developers create their own ExecSpec implementations.
AbstractToolExecSpec(Project, ExternalExecutable) - Constructor in AbstractToolExecSpec: Construct class and attach it to specific project.
AbstractToolExtension - Class in org.ysb33r.grolifant.api.exec: Use as a base class for extensions that will wrap tools.
AbstractToolExtension(Task, String) - Constructor in AbstractToolExtension: Attach this extension to a task
addEnvironmentToExecSpec(T) - Method in AbstractExecWrapperTask: Adds the configured environment to the execution specification.
addExecProjectExtension(String, Project, ExecSpecInstantiator<? extends AbstractToolExecSpec>) - Method in ExtensionUtils: Adds a project extension so that specific tools can be execute in a similar manner to Project.exec.
addExecutableToExecSpec(T) - Method in AbstractExecWrapperTask: Adds the exe to the execution specification.
ArtifactAttributeContainer - Class in org.ysb33r.grolifant.api.artifacts: Implementation of AttributeContainer
authentication(Action<? super AuthenticationContainer>) - Method in AuthenticationSupportedRepository
AuthenticationSupportedRepository - Class in org.ysb33r.grolifant.api.repositories: Base class for creating repository types that optionally support authentication.
AuthenticationSupportedRepository(Project) - Constructor in AuthenticationSupportedRepository: Base class constructor

B

bindDependencyHandlerService(Project, String, Class) - Method in ExtensionUtils: Binds a new extension handler on to the project dependency handler.
bindRepositoryHandlerService(Project, String, Class) - Method in ExtensionUtils: Binds a new extension handler on to the project repository handler.
bindService(Object, String, Object) - Method in ExtensionUtils: Binds a service object to the extensions object on an existing Gradle DSL Object
build(Map<String, Object>, Object) - Method in ResolvedExecutableFactory
build(Map<String, Object>, Object) - Method in ResolveExecutableByVersion: Creates ResolvableExecutable from a Packer version.
buildCommandLine() - Method in AbstractToolExecSpec: Builds up the command line.

C

CheckSumVerification - Interface in org.ysb33r.grolifant: DEPRECATED.
ClosureUtils - Class in org.ysb33r.grolifant.api: Methods for dealing with closures.
CloudGitConfigurator - Interface in org.ysb33r.grolifant.api.git: A description of a Git repository from a cloud provider
CloudGitDescriptor - Interface in org.ysb33r.grolifant.api.git: A description of a Git repository from a cloud provider
cmdArgs(Object) - Method in AbstractCommandExecSpec: Add more command-specific arguments.
cmdArgs(Object) - Method in AbstractCommandExecTask: Add more command-specific arguments.
command(Object) - Method in AbstractCommandExecSpec: Set the command to use.
command(Object) - Method in AbstractCommandExecTask: Set the command to use.
configure(Closure) - Method in AbstractToolExecSpec: Configure this spec from a closure.
configure(Action<? extends ToolExecSpec>) - Method in ToolExecSpec: Configure this spec from an Action
configure(Closure) - Method in ToolExecSpecGroovy: Configure this spec from a closure.
configureByName(Project, String, Closure) - Method in TaskProvider: Configures a task by name.
configureExecSpec() - Method in AbstractCommandExecTask: Configures the executions specification from settings.
configureExecSpec(T) - Method in AbstractExecWrapperTask: Configures an execution specification from task properties
configureExecSpec() - Method in AbstractScriptExecTask: Configures the executions specification from settings.
configureItem(Object, Closure) - Method in ClosureUtils: Configure this item using a closure
content(Action) - Method in AuthenticationSupportedRepository: This is currently a NOOP.
CopyExecSpec - Interface in org.ysb33r.grolifant.api.exec: Indicates that a class can copy settings to a standard ExecSpec.
copyTo(ProcessForkOptions) - Method in AbstractToolExecSpec: Copies options from this Spec to the given target.
copyToExecSpec(ExecSpec) - Method in AbstractToolExecSpec: Copies settings from this execution specification to a standard ExecSpec
copyToExecSpec(ExecSpec) - Method in CopyExecSpec: Copies settings from this execution specification to a standard ExecSpec
create(Project) - Method in ExecSpecInstantiator
create(Map<String, Object>, String, Project) - Method in ResolveExecutableByVersion.DownloaderFactory: Creates a downloader
createExecSpec() - Method in AbstractExecWrapperTask: Creates a new execution specification.
createProgressLogger(Project, String) - Method in LogUtils: Creates an instance of a progress logger that could be use to log progress to console
credentials(Class<? extends Credentials>) - Method in AuthenticationSupportedRepository

D

DependencyCache - Class in org.ysb33r.grolifant.api.artifacts: A custom implementation of a dependency cache when the one from Gradle might not be directly accessible.
DependencyCache.CacheRefresh - Interface in org.ysb33r.grolifant.api.artifacts: @deprecated Useorg.ysb33r.grolifant.api.v4.artifacts.DependencyCache.CacheRefresh instead.
DependencyCache.PostDownloadProcessor - Interface in org.ysb33r.grolifant.api.artifacts: @deprecated Useorg.ysb33r.grolifant.api.v4.artifacts.DependencyCache.PostDownloadProcessor instead.
DependencyCache(Project, String, String, DependencyCache.CacheRefresh, CheckSumVerification, DependencyCache.PostDownloadProcessor) - Constructor in DependencyCache

E

env - Field in AbstractExecSpec
environment(String, Object) - Method in AbstractExecSpec: Add additional environment variable for use with the process.
environment(Map<String, ?>) - Method in AbstractExecWrapperTask: Add environmental variables to be passed to the exe.
errorOutput(OutputStream) - Method in AbstractExecSpec: Set the stream where error output should be sent to for this process when executing.
exeArgs(Object) - Method in AbstractToolExecSpec: Add more tool-specific arguments.
exeArgs(Object) - Method in MutableToolExecSpec: Add more tool-specific arguments.
exec() - Method in AbstractExecWrapperTask: The default implementation will build an execution specification and run it.
ExecSpecInstantiator - Interface in org.ysb33r.grolifant.api.exec: Factory interface for instantiating execution specification.
executable(Map<String, Object>) - Method in AbstractToolExecSpec: Use a key-value approach to setting the exe.
executable(Map<String, ?>) - Method in AbstractToolExtension: Set the parameters for locating an exe.
executable(ResolvableExecutable) - Method in MutableToolExecSpec: Set the exe to use.
ExtensionUtils - Class in org.ysb33r.grolifant.api: Utilities to deal with Gradle extensions and project extensions
ExternalExecutable - Interface in org.ysb33r.grolifant.api.exec: A way to create a lazy-evaluated location of an external executable.
ExternalExecutableType - Interface in org.ysb33r.grolifant.api.exec: A way to create a lazy-evaluated parameters of an external executable.

F

filesFromCopySpec(CopySpec) - Method in FileUtils: Returns the file collection that a CopySpec describes.
FileUtils - Class in org.ysb33r.grolifant.api: Various file utilities.
findValidKey(Map<String, Object>) - Method in ResolverFactoryRegistry: Look for exactly one valid key in the supplied map.

G

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.
getAuthentication() - Method in AuthenticationSupportedRepository
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
getEnvironment() - Method in AbstractExecSpec: Returns the environment to be used for the process.
getEnvironment() - Method in AbstractExecWrapperTask: Environment for running the exe
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 ResolvableExecutable
getExecutableResolver() - Method in AbstractToolExecSpec: Access to the object that can resolve exe location from property maps.
getInstructionsArgs() - Method in AbstractToolExecSpec: List of arguments specific to the tool instruction.
getName() - Method in NamedResolvedExecutableFactory
getPath(T) - Method in ResolveExecutableByVersion.DownloadedExecutable: Given a downloader resolve the path to the exe.
getPkgName(URI) - Method in UriUtils: Get final package or directory name from a URI
getProject() - Method in AbstractCombinedProjectTaskExtension: Project this extension is associated with.
getProjectExtension() - Method in AbstractCombinedProjectTaskExtension: Returns the extension that is attached to the project.
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
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 ResolverFactoryRegistry
getResolver() - Method in AbstractToolExtension: Get access to object that can resolve an executable's location from a property map.
getResolverFactoryRegistry() - Method in AbstractToolExtension: Access to the registry of exe resolver factories.
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
getStandardInput() - Method in AbstractExecSpec: Where input is read from during execution.
getStandardOutput() - Method in AbstractExecSpec: Where standard output is sent to during execution.
getTask() - Method in AbstractCombinedProjectTaskExtension: Task this extension is attached to.
getToolExecSpec() - Method in AbstractCommandExecTask: Execution specification customised for the specific tool
getToolExtension() - Method in AbstractExecWrapperTask: Returns the extension that is associated with the specific tool
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.
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.
getValueByMethod(String) - Method in AbstractCombinedProjectTaskExtension: Uses reflection to invoke a method on a project extension or a task extension.
getWorkingDir() - Method in AbstractExecSpec: Obtain the working directory for this process.
GitHubArchive - Class in org.ysb33r.grolifant.api.git: Describes a GitHub archive
GitHubArchive() - Constructor in GitHubArchive
GitLabArchive - Class in org.ysb33r.grolifant.api.git: Describes a GitLab archive.
GitLabArchive() - Constructor in GitLabArchive
GitRepoArchiveDownloader - Class in org.ysb33r.grolifant.api.git: Downloads an archive of a Git repository.
GitRepoArchiveDownloader(CloudGitDescriptor, Project) - Constructor in GitRepoArchiveDownloader

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.
instructionArgs(Object) - Method in AbstractToolExecSpec: Add more instruction-specific arguments.
isIgnoreExitValue() - Method in AbstractExecSpec: State of exit value monitoring.

J

JavaForkOptions - Class in org.ysb33r.grolifant.api: Provides a class that can be populated with various fork options for Java and which can then be used to copy to other methods in the Gradle API that provides a JavaForkOptions in the parameters.

K

L

listDirs(File) - Method in FileUtils: Provides a list of directories below another directory
LogUtils - Class in org.ysb33r.grolifant.api: Various utilities related to logging.

M

MapUtils - Class in org.ysb33r.grolifant.api: Various utilities dealing with key-value pairs.
MutableToolExecSpec - Interface in org.ysb33r.grolifant.api.exec: Methods for setting executables and arguments.

N

NamedResolvedExecutableFactory - Interface in org.ysb33r.grolifant.api.exec: Provides a fixed name usable as a key.

O

P

project - Field in AbstractExecSpec
projectCacheDirFor(Project) - Method in FileUtils: Returns the project cache directory for the given project.
PropertyResolveOrder - Interface in org.ysb33r.grolifant.api: Resolves a property within a certain order
PropertyResolver - Class in org.ysb33r.grolifant.api: Resolves properties in a certain i.e. like SprintBoot, but less functionality to suite Gradle context.

Q

R

registerExecutableKeyActions(NamedResolvedExecutableFactory) - Method in ResolverFactoryRegistry

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

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

ResolvableExecutable - Interface in org.ysb33r.grolifant.api.exec

Holds a reference to an exe that will only be made available when explicitly called.

ResolvableExecutableType - Interface in org.ysb33r.grolifant.api.exec

Authors:: Schalk W.

resolveClassLocation(Class) - Method in FileUtils

Returns the classpath location for a specific class

ResolvedExecutable - Interface in org.ysb33r.grolifant.api.exec

Holds a reference to an exe that will only be made available when explicitly called.

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

Creates a org.ysb33r.grolifant.api.v4.exec.ResolvableExecutable.

ResolveExecutableByVersion - Class in org.ysb33r.grolifant.api.exec

Uses an implementation of an AbstractDistributionInstaller to find an exe by version number.

ResolveExecutableByVersion.DownloadedExecutable - Interface in org.ysb33r.grolifant.api.exec

ResolveExecutableByVersion.DownloaderFactory - Interface in org.ysb33r.grolifant.api.exec

ResolveExecutableByVersion(Project, ResolveExecutableByVersion.DownloaderFactory, ResolveExecutableByVersion.DownloadedExecutable) - Constructor in ResolveExecutableByVersion

Resolve by downloadable version.

ResolverFactoryRegistry - Class in org.ysb33r.grolifant.api.exec

A registry of factories for locating executables.

ResolverFactoryRegistry(Project) - Constructor in ResolverFactoryRegistry

Create a registry of factories for locating executables

runExecSpec(T) - Method in AbstractExecWrapperTask

S

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.
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.
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.
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(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.
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.
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.
setWorkingDir(File) - Method in AbstractExecSpec: Set the working directory for the execution.
SimplePasswordCredentials - Class in org.ysb33r.grolifant.api.repositories: Simple memory-based implementation of password credentials.
standardInput(InputStream) - Method in AbstractExecSpec: 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.
stringize(Iterable<?>) - Method in StringUtils: Converts a collection of most things to a list of strings.
stringizeValues(Map<String, Object>) - Method in MapUtils: Evaluates a map of objects to a map of strings.
StringUtils - Class in org.ysb33r.grolifant.api: A collection of utilities for converting to strings.

T

taskByName(Project, String) - Method in TaskProvider: Finds a task on the given project by name
taskByTypeAndName(Project, Class, String) - Method in TaskProvider: Finds a task by both type and name
TaskProvider - Class in org.ysb33r.grolifant.api: Utilities dealing with the creating of tasks allowing for lazy creation of tasks on Gradle 4.9+, but still use the standard Gradle TaskContainer.create API methods for earlier versions.
ToolExecSpec - Interface in org.ysb33r.grolifant.api.exec: Specified ways of configuring an execution specification for an external tool.
ToolExecSpecGroovy - Interface in org.ysb33r.grolifant.api.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

U

unpackDmgOnMacOsX(Project, String, File, String, File) - Method in UnpackUtils: Unpack a DMG image on MacOs.
UnpackUtils - Class in org.ysb33r.grolifant.api: Utilities to deal with unpacking certain formats.
updateStringProperty(Project, Provider<String>, Object) - Method in StringUtils: Updates a Provider.
UriUtils - Class in org.ysb33r.grolifant.api: Dealing with URIs
urize(Object) - Method in UriUtils: Attempts to convert object to a URI.