Index (grolifant-core 2.0.0-alpha.4 API)

ignoreEmptyDirectories(TaskInputs, Object) - Method in TaskToolsProxy: 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.
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
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 ProjectOperationsProxy: Executes the specified external java process.

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.

M

MacOsX - Class in org.ysb33r.grolifant.api.core.os: MacOSX implementation of OperatingSystem.
markIgnoreEmptyDirectories(TaskInputFilePropertyBuilder) - Method in TaskToolsProxy: Marks an input property to ignore empty directories.

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

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

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 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(ProjectOperations, Project) - Constructor in ProjectToolsProxy

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

Creates a Property instance with a default value

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

Q

R

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

S

safeUri(URI) - Method in StringToolsProxy: Create a URI where the user/password is masked out.
ScriptDefinition - Class in org.ysb33r.grolifant.api.core.executable: Defines a base class for implementing a script definition.
ScriptDefinition(ProjectOperations) - Constructor in ScriptDefinition
setArgs(List<String>) - Method in AbstractCmdlineArgumentSpec: Replace current arguments with a new set.
setBranch(Object) - Method in AbstractCloudGit: Set the branch.
setChecksum(String) - Method in AbstractDistributionInstaller: Set a checksum that needs to be verified against downloaded archive
setCommit(Object) - Method in AbstractCloudGit: 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.
setExecutableVersionProvider(Provider<String>) - Method in AbstractBaseToolExtension: Overrides the default way or determining what the version is of a tool.
setLocationPropertiesFile(Object) - Method in AbstractWrapperCacheBinaryTask
setName(Object) - Method in ScriptDefinition
setOrganisation(Object) - Method in AbstractCloudGit: Set the organisation.
setPath(Object) - Method in ScriptDefinition
setRepository(Object) - Method in AbstractCloudGit: Set the repository
setSdkManCandidateName(String) - Method in AbstractDistributionInstaller: Set candidate name for SdkMan if the latter should be searched for installed versions
setTag(Object) - Method in AbstractCloudGit: Set the tag.
setWindowsExtensionSearchOrder(String) - Method in AbstractBaseToolExtension
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
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
SYSTEM_ENV_PROPERTY - Field in PropertyResolver
systemProperty(Object, boolean) - Method in ProjectOperationsProxy: Creates a provider to a system property.

T

tarTree(Object) - Method in ProjectOperationsProxy: Returns a TAR tree presentation
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
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

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.
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.
updateStringProperty(Provider<String>, Object) - Method in ProjectOperationsProxy: Updates a string provider.
updateStringProperty(Property<String>, Object) - Method in StringToolsProxy: Updates a Property<String>.
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

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
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 ProjectOperationsProxy: Returns a ZIP tree presentation