Index (grolifant-core 2.2.0 API)

GenericBSD - Class in org.ysb33r.grolifant.api.core.os: Abstract base class for BSD-based operating systems.
GenericBSD() - Constructor in GenericBSD
GenericUnix - Class in org.ysb33r.grolifant.api.core.os: Generic Unix-like implementation of OperatingSystem.
GenericUnix() - Constructor in GenericUnix
get(String, String, PropertyResolveOrder) - Method in PropertyResolver: Gets a property using a specific resolve order
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 WorkerExecSpec: The list of all resovled application arguments.
getArch() - Method in GenericUnix: Architecture underlying the operating system
getArch() - Method in OperatingSystem: Architecture underlying the operating system
getArch() - Method in Windows: Architecture underlying the operating system
getArchiveOperations() - Method in ProjectOperationsProxy
getArchivePath() - Method in AbstractCloudGit: Calculates an archive path for the specific repository type.
getArchivePath() - Method in GitHubArchive: Calculates an archive path for the specific repository type.
getArchivePath() - Method in GitLabArchive: Calculates an archive path for the specific repository type.
getArchiveRoot() - Method in GitRepoArchiveDownloader: Returns the location which is the top or home folder for a distribution.
getArchiveUri() - Method in AbstractCloudGit: Obtains the URI for the archive of the repository.
getArchiveUri() - Method in CloudGitDescriptor: Obtains the URI for the archive of the repository.
getArchStr() - Method in GenericUnix: Implementation-specific free-form architecture string.
getArchStr() - Method in OperatingSystem: Architecture underlying the operating system
getArchStr() - Method in Solaris: Solaris-specific architecture strings.
getArchStr() - Method in Windows: Architecture underlying the operating system
getArgs() - Method in AbstractCmdlineArgumentSpec: Return list of arguments to the entrypoint.
getArgs() - Method in CmdlineArgumentSpec: Return list of arguments to the entrypoint.
getAuthentication() - Method in AbstractAuthenticationSupportedRepository
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
getCachedBinaryProperties() - Method in AbstractWrapperCacheBinaryTask
getChecksum() - Method in CheckSumVerification: Returns the checksum in question.
getClasspath() - Method in ClasspathSpec: Get classpath as a FileCollection.
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 JvmAppRunnerSpec: Provides direct access to the list of command-line processors.
getConfigurations() - Method in ProjectOperationsProxy: Tools to deal with Gradle configurations.
getConsoleOutput() - Method in ProjectOperationsProxy: Console output mode
getCredentials(Class<T>) - Method in AbstractAuthenticationSupportedRepository
getDestDirProvider() - Method in AbstractWrapperGeneratorTask
getDistFromCache(String) - Method in AbstractDistributionInstaller: Creates a distribution if it does not exist already.
getDistFromSdkMan(String) - Method in AbstractDistributionInstaller: Attempts to locate distribution in the list of SdkMan candidates.
getDistributionFile(String, String) - Method in AbstractDistributionInstaller: Locates a file within the distribution
getDistributionRoot(String) - Method in AbstractDistributionInstaller: Returns the location which is the top or home folder for a distribution.
getDownloader() - Method in AbstractToolExtension: Gets the downloader implementation.
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.
getErrorOutput() - Method in ProcessExecutionSpec: Returns the output stream to consume standard error from the process executing the command.
getExecOperations() - Method in ProjectOperationsProxy
getExecTools() - Method in ProjectOperationsProxy: Tools to deal with out-of-process, non-JVM, executables.
getExecutable() - Method in AbstractBaseToolExtension: A provider for a resolved executable.
getExecutable() - Method in BaseToolLocation: A provider for a resolved executable.
getExecutableLocation() - Method in AbstractExecWrapperWithExtensionTask: Location of executable.
getExecutableName(String) - Method in GenericUnix: Given a base string, returns the Unix exe name.
getExecutableName(String) - Method in OperatingSystem: Returns OS-specific decorated exe name.
getExecutableName(String) - Method in Windows
getExecutableNames(String) - Method in GenericUnix: Given a base string, returns the Unix exe name.
getExecutableNames(String) - Method in OperatingSystem: Returns list of possible OS-specific decorated exe names.
getExecutableNames(String) - Method in Windows
getExecutionSignature() - Method in JvmAppRunnerSpec: A unique string which determines whether there were any changes.
getExtensions() - Method in ProjectOperationsProxy: Extensions container for the project.
getFile() - Method in ClassLocation: If the class is located on the filesystem or in a JAR this will be the location.
getFile() - Method in FilePropertyWrapper: Gets the file referenced by this property.
getFileProvider() - Method in FilePropertyWrapper: Gets the provider for this file property
getFromCache(String, boolean, Downloader) - Method in ArtifactDownloader: Creates a distribution/file it it does not exist already.
getFromCache(URI, String, String) - Method in DependencyCache: Extract an artifact from cache.
getFsOperations() - Method in ProjectOperationsProxy: Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.
getFullProjectPath() - Method in ProjectOperationsProxy: Get the full project path including the root project name in case of a multi-project.
getGradleLogLevel() - Method in ProjectOperationsProxy: Get the minimum log level for Gradle.
getGradleUserHomeDir() - Method in ProjectOperationsProxy: Gradle user home directory.
getGroupProvider() - Method in ProjectOperationsProxy: Lazy-evaluated project group.https://gitlab.com/ysb33rOrg/grolifant/-/jobs/3248448094
getIdentifier() - 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.
getJvmEntrypoint() - Method in WorkerExecSpec: The JVM entry point.
getJvmForkOptions() - Method in AbstractJvmExecSpec
getJvmTools() - Method in ProjectOperationsProxy: Tools for working with JVMs
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 AbstractCloudGit: Obtains the name of the Git service.
getName() - Method in BaseScriptDefinition: Name of script.
getName() - Method in BaseScriptSpec: Provider to the name of a script.
getName() - Method in CloudGitDescriptor: Obtains the name of the Git service.
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.
getOrganisation() - Method in AbstractCloudGit: Get the organisation
getOrganisation() - Method in CloudGitDescriptor: Organisation on Git cloud service
getPath() - Method in OperatingSystem: List of system search paths
getPath() - Method in ScriptDefinition
getPath() - Method in ScriptSpec: Provider to the path of a script.
getPathSeparator() - Method in OperatingSystem: The character used to separate elements in a system search 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.
getProjectDir() - Method in ProjectOperationsProxy: 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 ProjectOperationsProxy: The project name
getProjectOperations() - Method in AbstractWrapperCacheBinaryTask
getProjectOperations() - Method in AbstractWrapperGeneratorTask
getProjectPath() - Method in ProjectOperationsProxy: Get project path.
getProjectRootDir() - Method in ProjectOperationsProxy: Returns the root directory of the project.
getProjectTools() - Method in ProjectOperationsProxy: 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.
getPropertyProvider() - Method in ProjectOperationsProxy
getProviders() - Method in ProjectOperationsProxy: A reference to the provider factory.
getProviderTools() - Method in ProjectOperationsProxy: Tools to deal with provider down to Gradle 4.0.
getRepository() - Method in AbstractCloudGit: Get the repository
getRepository() - Method in CloudGitDescriptor: Repository on Git cloud service
getRepositoryTools() - Method in ProjectOperationsProxy: Tools for dealing with repositories.
getRuntime() - Method in ClassLocation: If the class is located in a runtime module
getScriptDefinition() - Method in AbstractJvmScriptExecSpec: Returns the instance of the script definition.
getScriptName(String) - Method in GenericUnix: Returns OS-specific decorated script name.
getScriptName(String) - Method in OperatingSystem: Returns OS-specific decorated script name.
getScriptName(String) - Method in Windows: Returns Windows-specific decorated script name.
getSdkManCandidateName() - Method in AbstractDistributionInstaller: SDKman candidate name for distribution.
getServer() - Method in JvmDebugOptions: Whether a socket-attach or a socket-listen type of debugger is expected.
getSharedLibraryName(String) - Method in GenericUnix: Returns OS-specific shared library name
getSharedLibraryName(String) - Method in OperatingSystem: Returns OS-specific shared library name
getSharedLibraryName(String) - Method in Windows: Returns Windows shared library name
getSharedLibrarySuffix() - Method in GenericUnix: Return Unix-like string that is used to suffix to shared libraries
getSharedLibrarySuffix() - Method in MacOsX: Return MacOSX string that is used to suffix to shared libraries
getSharedLibrarySuffix() - Method in OperatingSystem: OS-dependent string that is used to suffix to shared libraries
getSingleFile(String) - Method in AbstractSingleFileInstaller: Returns the path to the terraform executable.
getSingleFileName() - Method in AbstractSingleFileInstaller: Gets the name of the single file as it should be on local disk
getStandardInput() - Method in ProcessExecutionSpec: Returns the standard input stream for the process executing the command.
getStandardOutput() - Method in ProcessExecutionSpec: Returns the output stream to consume standard output from the process executing the command.
getStaticLibraryName(String) - Method in GenericUnix: Returns OS-specific static library name
getStaticLibraryName(String) - Method in OperatingSystem: Returns OS-specific static library name
getStaticLibraryName(String) - Method in Windows: Returns OS-specific static library name
getStaticLibrarySuffix() - Method in OperatingSystem: OS-dependent string that is used to suffix to static libraries
getStringTools() - Method in ProjectOperationsProxy: 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.
getTasks() - Method in ProjectOperationsProxy: 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.
getVersionProvider() - Method in ProjectOperationsProxy: Lazy-evaluated project version.
getVersionProvider() - Method in ProjectToolsProxy: 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 BaseToolLocation: The order in which extensions will be checked for locating an executable on Windows.
getWrapperDestinationDirProvider() - Method in AbstractWrapperGeneratorTask: Directory for writing wrapper files to.
GitHubArchive - Class in org.ysb33r.grolifant.api.core.git: Describes a GitHub archive.
GitHubArchive(ProjectOperations) - Constructor in GitHubArchive
GitLabArchive - Class in org.ysb33r.grolifant.api.core.git: Describes a Gitlab archive.
GitLabArchive(ProjectOperations) - Constructor in GitLabArchive
GitRepoArchiveDownloader - Class in org.ysb33r.grolifant.api.core.git: Downloads an archive of a Git repository.
GitRepoArchiveDownloader(CloudGitDescriptor, ProjectOperations) - Constructor in GitRepoArchiveDownloader: Download archive from Git Cloud provider.
gradleProperty(Object, boolean) - Method in GradleSysEnvProvider
gradleProperty(Object, boolean) - Method in ProjectOperationsProxy: Creates a provider to a project property.
GradleSysEnvProvider - Interface in org.ysb33r.grolifant.api.core: An proxy to provide system properties, project properties and environmental variables as providers.
GrolifantError - Interface in org.ysb33r.grolifant.api.errors: A token interface for exception arising out of Grolifant library.
gzipResource(Object) - Method in ProjectOperationsProxy: Creates resource that points to a gzip compressed file at the given path.

H

hasCredentials() - Method in AbstractAuthenticationSupportedRepository: Check is any credentials has been accessed.
hashUri(URI) - Method in StringToolsProxy: Creates a SHA-256 has of a URI.

I

inputFiles(TaskInputs, Object, PathSensitivity, TaskInputFileOptions) - Method in TaskToolsProxy: Configure a collection of files as a task input.
INSTANCE - Field in Windows
IS_MACOSX - Field in AbstractDistributionInstaller
IS_WINDOWS - Field in AbstractDistributionInstaller
isConfigurationCacheEnabled() - Method in ProjectOperationsProxy: Whether configuration cache is enabled for a build.
isFreeBSD() - Method in FreeBSD
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 Linux: Confirms that this is an OS representation of a Linux operating system.
isLinux() - Method in OperatingSystem: Check is this is a Linux flavour
isMacOsX() - Method in MacOsX: Confirms that this is an OS representation of a Mac operating system.
isMacOsX() - Method in OperatingSystem: Check is this is Apple Mac OS X
isNetBSD() - Method in NetBSD: Confirms that this is an OS representation NetBSD.
isNetBSD() - Method in OperatingSystem: Check is this is NetBSD
isOffline() - Method in ProjectOperationsProxy: Whether Gradle is operating in offline mode.
isRefreshDependencies() - Method in ProjectOperationsProxy: Whether dependencies should be refreshed.
isRerunTasks() - Method in ProjectOperationsProxy: Whether tasks should be re-ruin
isRoot() - Method in ProjectOperationsProxy: Whether current project is the root project.
isSolaris() - Method in OperatingSystem: Check is this is a Solaris flavour
isSolaris() - Method in Solaris: Confirms this is a representation of the Solaris operating system.
isTaskProvider(Object) - Method in TaskToolsProxy: Whether this is a {@code TaskProvider
isUnix() - Method in GenericUnix: Confirms that this is a Unix-like operating system.
isUnix() - Method in OperatingSystem: Check is this is any kind of Unix-like O/S
isWindows() - Method in OperatingSystem: Check is this is Microsoft Windows
isWindows() - Method in Windows: Confirms this is a representation of the Microsoft Windows operating system.

J

javaexec(Action<? super JavaExecSpec>) - Method in ExecOperationsProxy: Executes the specified external java process.
javaexec(Action<? super JavaExecSpec>) - Method in ProjectOperationsProxy: Executes the specified external java process.
JavaForkOptionsWithEnvProvider - Interface in org.ysb33r.grolifant.api.core.jvm: Adds environment providers to JavaForkOptions.
jvm(Closure<?>) - Method in AbstractJvmExecSpec: Configures a JVM that will be forked.
jvm(Closure<?>) - Method in ForkedJvmExecutable: Configures a JVM that will be forked.
JvmAppRunnerSpec - Interface in org.ysb33r.grolifant.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.
JvmDebugOptions - Interface in org.ysb33r.grolifant.api.core.jvm
JvmEntryPoint - Interface in org.ysb33r.grolifant.api.core.jvm: Configures a class name or module.
JvmExecMethods - Interface in org.ysb33r.grolifant.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.

K

L

LegacyLevel - Class in org.ysb33r.grolifant.api.core: Internal used enumeration to help with logic with specific Gradle version differences.
Linux - Class in org.ysb33r.grolifant.api.core.os: Linux implementation of OperatingSystem.
listDirs(File) - Method in AbstractDistributionInstaller: Provides a list of directories below an unpacked distribution
listDirs(File) - Method in FileSystemOperationsProxy: Provides a list of directories below another directory
loadPropertiesFromResource(String) - Method in ResourceUtils: Loads properties from a resource file.
loadTextFromResource(String) - Method in ResourceUtils: Loads a resource text file into memory.
log(String) - Method in BaseProgressLogger: Sends a progress message.
logProgress(String) - Method in Downloader: Logs a progress message.

M

MacOsX - Class in org.ysb33r.grolifant.api.core.os: MacOSX implementation of OperatingSystem.
MainClassSpec - Interface in org.ysb33r.grolifant.api.core.jvm: Defines a JVM main class.
ModularitySpec - Interface in org.ysb33r.grolifant.api.core.jvm: Handles modularity specification.

N

needsSpecificGrolifantLibrary(String) - Method in NotSupportedException
NetBSD - Class in org.ysb33r.grolifant.api.core.os: NetBSD implementation of OperatingSystem.
noGlobalExecSearch - Field in AbstractBaseToolExtension
noProjectExtension() - Method in AbstractBaseToolExtension: Pass to the task constructor when no project extension will be available or required.
NotSupportedException - Class in org.ysb33r.grolifant.api.errors: Feature is not supported on this version of Gradle.

O

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

P

packageNameFromUri(URI) - Method in StringToolsProxy

Get final package or directory name from a URI

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

Processes a file post-download.

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_6 - Field in LegacyLevel

PRE_8_0 - Field in LegacyLevel

PRE_8_2 - Field in LegacyLevel

PRE_8_4 - Field in LegacyLevel

process(Closure<?>) - Method in AbstractExecSpec

Configures the stream redirections and exit checks.

process(Closure<?>) - Method in AbstractJvmExecSpec

Configures the stream redirections and exit checks.

process(Closure<?>) - Method in Executable

Configures the stream redirections and exit checks.

process(Closure<?>) - Method in ForkedJvmExecutable

Configures the stream redirections and exit checks.

process(File) - Method in PostDownloadProcessor

ProcessExecutionSpec - Interface in org.ysb33r.grolifant.api.core.executable

Describes the data stream redirections for a process including exit checks.

ProgressLogger - Interface in org.ysb33r.grolifant.api.core

Allows implementation against

PROJECT_SYSTEM_ENV - Field in PropertyResolver

projectDir - Field in FileSystemOperationsProxy

The project directory.

projectDirPath - Field in FileSystemOperationsProxy

The project directory as java.nio.file.Path.

projectOperations - Field in AbstractDistributionInstaller

Project operations that can used during downloading.

projectOperations - Field in AbstractExecSpec

projectOperations - Field in ProjectToolsProxy

projectOperations - Field in TaskToolsProxy

ProjectOperationsProxy - Class in org.ysb33r.grolifant.loadable.core

ProjectOperationsProxy(Project) - Constructor in ProjectOperationsProxy

ProjectToolsProxy - Class in org.ysb33r.grolifant.loadable.core

Authors:: Schalk W.

ProjectToolsProxy.GradleProjectVersion - Class in org.ysb33r.grolifant.loadable.core

ProjectToolsProxy.GradleProjectVersion(ProjectToolsProxy, ObjectFactory) - Constructor in ProjectToolsProxy.GradleProjectVersion

ProjectToolsProxy(ProjectOperations, Project, Provider<String>) - Constructor in ProjectToolsProxy

property(Class<T>, Provider<T>) - Method in ProviderToolsProxy

Creates a Property instance with a default value

PropertyResolveOrder - Interface in org.ysb33r.grolifant.api.core

Resolves a property within a certain order

PropertyResolver - Class in org.ysb33r.grolifant.api.core.resolvers

Resolves properties in a certain i.e. like SpringBoot, but less functionality to suite Gradle context.

PropertyResolver(ProjectOperations) - Constructor in PropertyResolver

Creates a property resolver with a custom resolve order

provide(String, String, PropertyResolveOrder, boolean) - Method in PropertyResolver

Gets a provider to a property using a specific resolve order.

provideAtConfiguration(String, String) - Method in PropertyResolver

Gets a provider to a property that is safe to use at configuration-time.

providerFactory - Field in FileSystemOperationsProxy

Provider factory

providerFactory - Field in ProviderToolsProxy

providerFactory - Field in TaskToolsProxy

ProviderToolsProxy - Class in org.ysb33r.grolifant.loadable.core

Common code code org.ysb33r.grolifant.api.core.ProviderTools.

ProviderToolsProxy(ProviderFactory, ObjectFactory) - Constructor in ProviderToolsProxy

ProviderToString - Class in org.ysb33r.grolifant.api.core

A proxy class that can be used for seom methods that take an Object and then simply use toString() on that object.

proxy(Provider<String>) - Method in ProviderToString

Q

R

refresh(URI, File) - Method in CacheRefresh: Refreshed the cache from a remtoe site into a local filesystem.
relativePath(Object) - Method in FileSystemOperationsProxy: Returns the relative path from the project directory to the given path.
relativePath(Object) - Method in ProjectOperationsProxy: Returns the relative path from the project directory to the given path.
relativePathToProjectDir(Object) - Method in FileSystemOperationsProxy: Returns the relative path from the given path to the project directory.
relativePathToRootDir(Object) - Method in FileSystemOperationsProxy: Returns the relative path from the given path to the root project directory.
relativeRootPath(Object) - Method in FileSystemOperationsProxy: Returns the relative path from the root project directory to the given path.
relativize(Path, Path) - Method in FileSystemOperationsProxy: Returns the path of one Path relative to another.
resolve(Object, Object, boolean) - Method in GradleSysEnvProvider: Resolves a property in order of Gradle, system, environment variable.
resolve(ProjectOperations, String, boolean) - Method in PropertyResolveOrder: A provider to a property.
resolvedExecutableVersion() - Method in AbstractBaseToolExtension: If configured by version returns that, otherwise it might run the executable to obtain the version.
resolveDistributionLocationForVersion(String) - Method in AbstractDistributionInstaller: Resolves distribution location by looking in various locations.
resolveExecutable() - Method in AbstractBaseToolExtension: Resolves an executable to a physical local file location.
resolveExecutable() - Method in AbstractToolExtension
resolveFilesFromCopySpec(CopySpec) - Method in FileSystemOperationsProxy: Given a {@Link CopySpec}, resolve all of the input files in to a collection.
resolveProperty(Object, Object, boolean) - Method in ProjectOperationsProxy: Searches by Gradle property, then system property and finally by environment variable using the PropertyResolver convention.
ResourceAccessException - Class in org.ysb33r.grolifant.api.errors: Thrown when there are sissues loading resources from the classpath.
ResourceUtils - Class in org.ysb33r.grolifant.api.core: Helps with loading specific resources
rootDir - Field in FileSystemOperationsProxy: The root project directory.
rootDirPath - Field in FileSystemOperationsProxy: The project root directory as java.nio.file.Path.
runExecutableAndReturnVersion() - Method in AbstractBaseToolExtension: Runs the executable and returns the version.
runnerSpec(Closure<?>) - Method in AbstractExecSpec: Configures the arguments.
runnerSpec(Closure<?>) - Method in AbstractJvmExecSpec: Configures the arguments.
runnerSpec(Closure<?>) - Method in Executable: Configures the arguments.
runnerSpec(Closure<?>) - Method in ForkedJvmExecutable: Configures the arguments.

S

safeUri(URI) - Method in StringToolsProxy: Create a URI where the user/password is masked out.
script(Closure<?>) - Method in AbstractJvmScriptExecSpec: Configures script elements by Groovy closure.
script(Closure<?>) - Method in AbstractJvmScriptExecTask: Configures script elements by Groovy closure.
script(Closure<?>) - Method in AbstractScriptExecSpec: @param specConfigurator Configurating closure.
script(Closure<?>) - Method in AbstractScriptExecTask: Configures script elements by Groovy closure.
script(Closure<?>) - Method in ExecutableScript: Configures script elements by Groovy closure.
script(Closure<?>) - Method in ForkedJvmScript: Configures script elements by Groovy closure.
ScriptDefinition - Class in org.ysb33r.grolifant.api.core.executable: Defines a base class for implementing a script definition.
ScriptDefinition(ProjectOperations) - Constructor in ScriptDefinition
ScriptSpec - Interface in org.ysb33r.grolifant.api.core.executable: Describes how to configure a script and its arguments.
setArgs(List<String>) - Method in AbstractCmdlineArgumentSpec: Replace current arguments with a new set.
setArgs(Iterable<?>) - Method in CmdlineArgumentSpec: Replace current arguments with a new set.
setBaseUri(URI) - Method in CloudGitConfigurator
setBranch(Object) - Method in AbstractCloudGit: Set the branch.
setBranch(Object) - Method in CloudGitConfigurator: Set the branch.
setChecksum(String) - Method in AbstractDistributionInstaller: Set a checksum that needs to be verified against downloaded archive
setClasspath(FileCollection) - Method in ClasspathSpec: Replace existing classpath with a new collection of files.
setCommand(Object) - Method in CommandEntryPoint: Set the lazy-evalued command.
setCommand(Object) - Method in ExecutableCommandSpec: Set the command to use.
setCommit(Object) - Method in AbstractCloudGit: Set the commit to use.
setCommit(Object) - Method in CloudGitConfigurator: Set the commit to use.
setDeleteTemplatesAfterUsage(boolean) - Method in AbstractWrapperGeneratorTask: Whether templates should be deleted after usage.
setDownloadRoot(Object) - Method in AbstractDistributionInstaller: Sets a download root directory for the distribution.
setDownloadRoot(File) - Method in DependencyCache: Sets a root directory for the cache.
setDownloadRoot(File) - Method in GitRepoArchiveDownloader: Sets a download root directory for the distribution.
setEnabled(Object) - Method in JvmDebugOptions: Whether to attach a debug agent to the forked process.
setErrorOutput(OutputStream) - Method in ProcessExecutionSpec: Sets the output stream to consume standard error from the process executing the command.
setExecutableVersionProvider(Provider<String>) - Method in AbstractBaseToolExtension: Overrides the default way or determining what the version is of a tool.
setFile(Object) - Method in FilePropertyWrapper: Sets a lazy-evaluated file.
setIgnoreExitValue(boolean) - Method in ProcessExecutionSpec: Sets whether a non-zero exit value is ignored, or an exception thrown.
setInferModulePath(Provider<Boolean>) - Method in ModularitySpec: Whether module path should be inferred.
setLocationPropertiesFile(Object) - Method in AbstractWrapperCacheBinaryTask
setMainClass(Object) - Method in MainClassSpec: Set the main class name.
setMainModule(Object) - Method in ModularitySpec: Set the main module name.
setName(Object) - Method in BaseScriptDefinition: Sets the name of the script to use.
setName(Object) - Method in BaseScriptSpec: Set the name of the script.
setName(Object) - Method in ScriptDefinition
setOrganisation(Object) - Method in AbstractCloudGit: Set the organisation.
setOrganisation(Object) - Method in CloudGitConfigurator: Set the organisation.
setPath(Object) - Method in ScriptDefinition
setPath(Object) - Method in ScriptSpec: Sets the path of the script including the name of the script.
setPort(Object) - Method in JvmDebugOptions: THe debug port.
setRepository(Object) - Method in AbstractCloudGit: Set the repository
setRepository(Object) - Method in CloudGitConfigurator: Set the repository
setSdkManCandidateName(String) - Method in AbstractDistributionInstaller: Set candidate name for SdkMan if the latter should be searched for installed versions
setServer(Object) - Method in JvmDebugOptions: Whether a socket-attach or a socket-listen type of debugger is expected.
setSetDefaultPreArgsProvider(Provider<List<String>>) - Method in ScriptDefinition: Override the default pre-argument provider.
setStandardInput(InputStream) - Method in ProcessExecutionSpec: Sets the standard input stream for the process executing the command.
setStandardOutput(OutputStream) - Method in ProcessExecutionSpec: Sets the output stream to consume standard output from the process executing the command.
setSuspend(Object) - Method in JvmDebugOptions: Whether the forked process should be suspended until the connection to the debugger is established.
setTag(Object) - Method in AbstractCloudGit: Set the tag.
setTag(Object) - Method in CloudGitConfigurator: Set the tag.
setVersion(Object) - Method in ProjectToolsProxy.GradleProjectVersion
setVersionProvider(Object) - Method in ProjectToolsProxy: Sets a new version for a project.
setWindowsExtensionSearchOrder(String) - Method in AbstractBaseToolExtension
setWindowsExtensionSearchOrder(String) - Method in BaseToolLocation: When searching for executables, the order in which to use check for file extensions.
setWrapperDestinationDirectory(Object) - Method in AbstractWrapperGeneratorTask: Sets the wrapper destination directory
SimplePasswordCredentials - Class in org.ysb33r.grolifant.api.core.repositories: Simple memory-based implementation of password credentials.
Solaris - Class in org.ysb33r.grolifant.api.core.os
StandardWorkerAppParameterFactory - Class in org.ysb33r.grolifant.api.core.jvm.worker: Standard parameters for running a JVM process inside a worker.
started() - Method in ProgressLogger: Allow logging to start
stringize(Collection<?>) - Method in StringToolsProxy: Converts a collection of most things to a list of strings.
stringizeDropNull(Collection<?>) - Method in StringToolsProxy: Like stringize, but drops any nulls, or empty instances of Provider and java.util.Optional.
stringizeOrNull(Object) - Method in StringToolsProxy: Like stringize, but returns null rather than throwing an exception, when item is null, an empty {@Link Provider} or an empty java.util.Optional.
StringToolsProxy - Class in org.ysb33r.grolifant.loadable.core
StringToolsProxy(ProviderFactory) - Constructor in StringToolsProxy
submitToWorkQueue(WorkerIsolation, WorkerExecutor, WorkerAppExecutorFactory<P>, WorkerAppParameterFactory<P>) - Method in AbstractJvmExecSpec: Submits this to a worker queue using an appropriate isolation mode.
submitToWorkQueue(WorkerIsolation, WorkerExecutor, WorkerAppExecutorFactory<P>, WorkerAppParameterFactory<P>) - Method in JvmAppRunnerSpec: Submits this to a worker queue using an appropriate isolation mode.
SYSTEM_ENV_PROPERTY - Field in PropertyResolver
systemProperty(Object, boolean) - Method in GradleSysEnvProvider
systemProperty(Object, boolean) - Method in ProjectOperationsProxy: Creates a provider to a system property.

T

tarTree(Object) - Method in ArchiveOperationsProxy
tarTree(Object) - Method in ProjectOperationsProxy: Returns a TAR tree presentation
TaskInputFileOptions - Enum in org.ysb33r.grolifant.api.core: Configuration options for declaring files input properties.
taskize(Iterable<Object>) - Method in TaskToolsProxy: Resolves a list of many objects to tasks items to a provider of tasks.
taskProviderFrom(Object) - Method in TaskToolsProxy: Creates a basic task Provider instance from an object.
tasks - Field in TaskToolsProxy
TaskToolsProxy - Class in org.ysb33r.grolifant.loadable.core: Non-Gradle API-specific common code from org.ysb33r.grolifant.api.core.TaskTools.
TaskToolsProxy(ProjectOperations, Project) - Constructor in TaskToolsProxy
ToolLocation - Interface in org.ysb33r.grolifant.api.core.runnable: Sets the definition on how to find a tool.
ToolWrapper - Class in org.ysb33r.grolifant.api.core.wrappers: Implementation utilities for creating tool wrappers
ToolWrapper(ProjectOperations) - Constructor in ToolWrapper
toSafeFileName(String) - Method in FileSystemOperationsProxy: Converts a string into a string that is safe to use as a file name.
toSafePath(String) - Method in FileSystemOperationsProxy: Converts a collection of String into a java.nio.file.Path with all parts guarantee to be safe file parts
toString() - Method in AbstractCloudGit: Content as a string
toString() - Method in OperatingSystem: Stringize implementation
toString() - Method in ProjectToolsProxy.GradleProjectVersion
toString() - Method in ProviderToString

U

UnexpectedNullException - Class in org.ysb33r.grolifant.api.errors: Can be thrown when null is encountered in an unexpected location and the system wants to deal with it more gracefully than a NullPointerException.
UnexpectedNullException(String, Throwable) - Constructor in UnexpectedNullException
unpack(File, File) - Method in AbstractDistributionInstaller: Unpacks a downloaded archive.
unpackDMG(File, File) - Method in AbstractDistributionInstaller: Provides the capability of unpacking an MSI file under Mac OSX by calling out to hdiutil.
unpackMSI(File, File, Map<String, String>) - Method in AbstractDistributionInstaller: Provides the capability of unpacking an MSI file under Windows by calling out to msiexec.
unsetNonPaths() - Method in AbstractBaseToolExtension: This is used when path or search path is set to unset other search mechanisms.
unsetNonPaths() - Method in AbstractToolExtension: This is used when path or search path is set to unset other search mechanisms.
unsetPaths() - Method in AbstractBaseToolExtension: Unset both the fixed path and search path.
UNSPECIFIED_PROJECT_GROUP - Field in ProjectToolsProxy
UNSPECIFIED_PROJECT_VERSION - Field in ProjectToolsProxy
UnsupportedConfigurationException - Class in org.ysb33r.grolifant.api.errors: Thrown when a type instance cannot be converted to a Gradle-specific type instance.
UnsupportedConfigurationException(String, Throwable) - Constructor in UnsupportedConfigurationException
updateFileProperty(Property<File>, Object) - Method in FileSystemOperationsProxy: Updates a Property<File>.
updateFileProperty(Provider<File>, Object) - Method in ProjectOperationsProxy: Updates a file provider.
updateLegacyVersion() - Method in ProjectToolsProxy
updateStringProperty(Provider<String>, Object) - Method in ProjectOperationsProxy: Updates a string provider.
updateStringProperty(Property<String>, Object) - Method in StringToolsProxy: Updates a Property<String>.
updateVersion(Provider<String>) - Method in ProjectToolsProxy
updateVersion(Provider<String>) - Method in ProjectToolsProxy.GradleProjectVersion
urize(Object) - Method in StringToolsProxy: Attempts to convert object to a URI.
useWrapperTemplatesInResources(String, Map<String, String>) - Method in AbstractWrapperGeneratorTask: Use wrapper templates from resources classpath

V

verify(File) - Method in CheckSumVerification: Verifies a file against a checksum
verifyDistributionRoot(File) - Method in AbstractDistributionInstaller: Validates that the unpacked distribution is good.
verifyDistributionRoot(File) - Method in AbstractSingleFileInstaller: Validates that the downloaded file is good.
verifyDownloadChecksum(String, File, String) - Method in AbstractDistributionInstaller: Verifies the checksum (if provided) of a newly downloaded distribution archive.
Version - Class in org.ysb33r.grolifant.api.core: A class for comparing versions.
Version.ParseException - Class in org.ysb33r.grolifant.api.core
Version.ParseException(String, Throwable) - Constructor in Version.ParseException
Version.Parts - Class in org.ysb33r.grolifant.api.core
version - Field in AbstractToolExtension
Version(String, Version.Parts) - Constructor in Version: Creates an instance of a Version object.

W

Windows - Class in org.ysb33r.grolifant.api.core.os: Windows implementation of OperatingSystem.
Windows() - Constructor in Windows
withDebug(Action<JvmDebugOptions>) - Method in JavaForkOptionsWithEnvProvider
WorkerAppParameterFactory - Interface in org.ysb33r.grolifant.api.core.jvm.worker: Creates a worker parameter POJO and optional configures it from execution specifications.
WorkerExecSpec - Interface in org.ysb33r.grolifant.api.core.jvm.worker: Describes the necessary information that might be needed to run a JVM process inside a worker.
WorkerIsolation - Enum in org.ysb33r.grolifant.api.core.jvm.worker: Isolation mode for running a worker
workerIsolation() - Method in ExecutionMode: If the execution mode is worker related, return the appropriate isolation mode
WorkerPromise - Interface in org.ysb33r.grolifant.api.core.jvm.worker: Allows a task to block other tasks in the same project until all work related to the queue is completed.
wrapperCopyAction(Collection<File>, File, String, String, Map<String, String>) - Method in ToolWrapper: Configures an action for transforming a collection files using Ant-style replace tokens filter.
WrapperCreationException - Class in org.ysb33r.grolifant.api.errors: Thrown when a tool wrapper script cannot be created.
writePropertiesShellFile(File, Map<String, String>) - Method in AbstractWrapperCacheBinaryTask: Write a shell file of properties.
writeWindowsPropertiesBatFile(File, Map<String, String>) - Method in AbstractWrapperCacheBinaryTask: Writes a Windows batch file of property values that can be included by a wrapper script.

X

Y

Z

zipTree(Object) - Method in ArchiveOperationsProxy
zipTree(Object) - Method in ProjectOperationsProxy: Returns a ZIP tree presentation