ProjectOperationsProxy (grolifant-core 2.0.0 API)

org.ysb33r.grolifant.loadable.core.ProjectOperationsProxy

All Implemented Interfaces and Traits:: org.ysb33r.grolifant.api.core.ProjectOperations

@SuppressWarnings('MethodCount')
@groovy.transform.CompileStatic
abstract class ProjectOperationsProxy
extends Object

Constructor Summary

Constructors
Constructor and description
`protected ProjectOperationsProxy (Project tempProjectReference)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ReadableResource`	`bzip2Resource(Object compressedFile)` Creates resource that points to a bzip2 compressed file at the given path.
	`WorkResult`	`copy(Action<? super CopySpec> action)` Performs a copy according to copy specification.
	`boolean`	`delete(Object... paths)`
	`WorkResult`	`delete(Action<? super DeleteSpec> action)`
	`Provider<String>`	`environmentVariable(Object name, boolean configurationTimeSafety)` Creates a provider to an environmental variable.
	`ExecResult`	`exec(Action<? super ExecSpec> action)` Executes the specified external process.
	`File`	`file(Object path)` Convert an object to a file
	`File`	`fileOrNull(Object file)` Similar to {@Link #file}, but does not throw an exception if the object is `null` or an empty provider.
	`java.util.List<File>`	`fileize(Iterable<Object> files)` Converts a collection of file-like objects to a list of File instances with project context.
	`FileCollection`	`files(Object... paths)`
	`protected org.ysb33r.grolifant.api.core.ArchiveOperationsProxy`	`getArchiveOperations()`
	`ConsoleOutput`	`getConsoleOutput()` Console output mode
	`protected org.ysb33r.grolifant.api.core.ExecOperationsProxy`	`getExecOperations()`
	`org.ysb33r.grolifant.api.core.ExecTools`	`getExecTools()` Tools to deal with out-of-process, non-JVM, executables.
	`ExtensionContainer`	`getExtensions()` Extensions container for the project.
	`org.ysb33r.grolifant.api.core.FileSystemOperations`	`getFsOperations()` Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.
	`String`	`getFullProjectPath()` Get the full project path including the root project name in case of a multi-project.
	`LogLevel`	`getGradleLogLevel()` Get the minimum log level for Gradle.
	`Provider<File>`	`getGradleUserHomeDir()` Gradle user home directory.
	`Provider<String>`	`getGroupProvider()` Lazy-evaluated project group.https://gitlab.com/ysb33rOrg/grolifant/-/jobs/3248448094
	`org.ysb33r.grolifant.api.core.JvmTools`	`getJvmTools()` Tools for working with JVMs
	`File`	`getProjectDir()` Returns the project directory.
	`String`	`getProjectName()` The project name
	`String`	`getProjectPath()` Get project path.
	`File`	`getProjectRootDir()` Returns the root directory of the project.
	`org.ysb33r.grolifant.api.core.ProjectTools`	`getProjectTools()` Tools to deal with project & configuration specifics down to Gradle 4.0.
	`protected org.ysb33r.grolifant.api.core.GradleSysEnvProvider`	`getPropertyProvider()`
	`org.ysb33r.grolifant.api.core.ProviderTools`	`getProviderTools()` Tools to deal with provider down to Gradle 4.0.
	`ProviderFactory`	`getProviders()` A reference to the provider factory.
	`org.ysb33r.grolifant.api.core.RepositoryTools`	`getRepositoryTools()` Tools for dealing with repositories.
	`org.ysb33r.grolifant.api.core.StringTools`	`getStringTools()` Tools for dealing with conversions of various objects into string or lists of strings.
	`org.ysb33r.grolifant.api.core.TaskTools`	`getTasks()` Utilities for working with tasks in a consistent manner across Gradle versions.
	`Provider<String>`	`getVersionProvider()` Lazy-evaluated project version.
	`Provider<String>`	`gradleProperty(Object name, boolean configurationTimeSafety)` Creates a provider to a project property.
	`ReadableResource`	`gzipResource(Object compressedFile)` Creates resource that points to a gzip compressed file at the given path.
	`boolean`	`isConfigurationCacheEnabled()` Whether configuration cache is enabled for a build.
	`boolean`	`isOffline()` Whether Gradle is operating in offline mode.
	`boolean`	`isRefreshDependencies()` Whether dependencies should be refreshed.
	`boolean`	`isRerunTasks()` Whether tasks should be re-ruin
	`boolean`	`isRoot()` Whether current project is the root project.
	`ExecResult`	`javaexec(Action<? super JavaExecSpec> action)` Executes the specified external java process.
	`String`	`relativePath(Object f)` Returns the relative path from the project directory to the given path.
	`Provider<String>`	`resolveProperty(Object name, Object defaultValue, boolean configurationTimeSafety)` Searches by Gradle property, then system property and finally by environment variable using the `PropertyResolver convention`.
	`Provider<String>`	`systemProperty(Object name, boolean configurationTimeSafety)` Creates a provider to a system property.
	`FileTree`	`tarTree(Object tarPath)` Returns a TAR tree presentation
	`void`	`updateFileProperty(Provider<File> provider, Object file)` Updates a file provider.
	`void`	`updateStringProperty(Provider<String> provider, Object str)` Updates a string provider.
	`FileTree`	`zipTree(Object zipPath)` Returns a ZIP tree presentation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - protected ProjectOperationsProxy(Project tempProjectReference)
- Method Detail
  - @Override ReadableResource bzip2Resource(Object compressedFile)
    
    Creates resource that points to a bzip2 compressed file at the given path.
    Parameters:
    compressedFile - File evaluated as per file.
    Returns:
    Readable resource
  - @Override WorkResult copy(Action<? super CopySpec> action)
    
    Performs a copy according to copy specification.
    Parameters:
    action - Copy specification
    Returns:
    Result of copy operation.
  - @Override boolean delete(Object... paths)
  - @Override WorkResult delete(Action<? super DeleteSpec> action)
  - @Override Provider<String> environmentVariable(Object name, boolean configurationTimeSafety)
    
    Creates a provider to an environmental variable.
    Parameters:
    name - Anything convertible to a string
    configurationTimeSafety - Whether this property can be read safely at configuration time. It is suggested to just use atConfigurationTime for this parameter
    Returns:
    Provider to the value of the an environmental variable.
  - @Override ExecResult exec(Action<? super ExecSpec> action)
    
    Executes the specified external process.
    Parameters:
    action
    Returns:
    ExecResult that can be used to check if the execution worked.
  - @Override File file(Object path)
    
    Convert an object to a file
    Parameters:
    path - Path to convert.
    Returns:
    File object
  - @Override File fileOrNull(Object file)
    
    Similar to {
    Link:
    #file}, but does not throw an exception if the object is null or an empty provider.
    
    Parameters:
    file - Potential File object
    Returns:
    File instance or null.
    Since:
    1.2
  - @Override java.util.List<File> fileize(Iterable<Object> files)
    
    Converts a collection of file-like objects to a list of File instances with project context.
    It will convert anything that the singular version of FileUtils.fileize can do. In addition it will recursively resolve any collections that result out of resolving the supplied items.
    Parameters:
    files - List of object to evaluate
    Returns:
    List of resolved files.
  - @Override FileCollection files(Object... paths)
    
    Creates a FileCollection containing the given files, as defined by Project#files(Object ...).
    This method can also be used to create an empty collection, but the collection may not be mutated later.
    deprecated:
    USe org.ysb33r.grolifant.api.core.FileSystemOperations#files instead.
    
    Parameters:
    paths - The paths to the files. May be empty.
    Returns:
    The file collection. Never returns null.
  - protected org.ysb33r.grolifant.api.core.ArchiveOperationsProxy getArchiveOperations()
  - @Override ConsoleOutput getConsoleOutput()
    
    Console output mode
    Returns:
    How the console output has been requested.
  - protected org.ysb33r.grolifant.api.core.ExecOperationsProxy getExecOperations()
  - @Override org.ysb33r.grolifant.api.core.ExecTools getExecTools()
    
    Tools to deal with out-of-process, non-JVM, executables.
    Returns:
    Tools instance optimised for current version of Gradle (where possible).
  - @Override @Deprecated ExtensionContainer getExtensions()
    
    Extensions container for the project.
    Returns:
    Reference to the extensions container
  - @Override org.ysb33r.grolifant.api.core.FileSystemOperations getFsOperations()
    
    Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.
    Returns:
    Instance of org.ysb33r.grolifant.api.core.FileSystemOperations
  - @Override String getFullProjectPath()
    
    Get the full project path including the root project name in case of a multi-project.
    Returns:
    The fully qualified project path including root project.
    Since:
    1.2
  - @Override LogLevel getGradleLogLevel()
    
    Get the minimum log level for Gradle.
    Returns:
    Log level
  - @Override Provider<File> getGradleUserHomeDir()
    
    Gradle user home directory. Usually ~/.gradle on non -Windows.
    Returns:
    Directory.
  - @Override Provider<String> getGroupProvider()
    
    Lazy-evaluated project group.https://gitlab.com/ysb33rOrg/grolifant/-/jobs/3248448094
    Returns:
    provider to project group
  - org.ysb33r.grolifant.api.core.JvmTools getJvmTools()
    
    Tools for working with JVMs
    Returns:
    The appropriate provider for the Gradle version.
    Since:
    2.0
  - @Override File getProjectDir()
    
    Returns the project directory.
    Returns:
    Project directory.
  - @Override String getProjectName()
    
    The project name
    Returns:
    Cached value of project name.
  - @Override String getProjectPath()
    
    Get project path.
    Returns:
    The fully qualified project path.
    Since:
    1.2
  - @Override File getProjectRootDir()
    
    Returns the root directory of the project.
    Returns:
    Root directory.
    Since:
    2.0
  - @Override org.ysb33r.grolifant.api.core.ProjectTools getProjectTools()
    
    Tools to deal with project & configuration specifics down to Gradle 4.0.
    Returns:
    Tools instance optimised for current version of Gradle (where possible).
  - protected org.ysb33r.grolifant.api.core.GradleSysEnvProvider getPropertyProvider()
  - @Override org.ysb33r.grolifant.api.core.ProviderTools getProviderTools()
    
    Tools to deal with provider down to Gradle 4.0.
    Returns:
    Tools instance optimised for current version of Gradle (where possible).
  - @Override ProviderFactory getProviders()
    
    A reference to the provider factory.
    Returns:
    ProviderFactory
  - @Override org.ysb33r.grolifant.api.core.RepositoryTools getRepositoryTools()
    
    Tools for dealing with repositories.
    Returns:
    Tools instance.
    Since:
    2.0
  - @Override org.ysb33r.grolifant.api.core.StringTools getStringTools()
    
    Tools for dealing with conversions of various objects into string or lists of strings.
    Returns:
    String tools instance.
    Since:
    2.0
  - @Override org.ysb33r.grolifant.api.core.TaskTools getTasks()
    
    Utilities for working with tasks in a consistent manner across Gradle versions.
    Returns:
    org.ysb33r.grolifant.api.core.TaskTools instance.
    Since:
    1.3
  - @Override Provider<String> getVersionProvider()
    
    Lazy-evaluated project version.
    Returns:
    Provider to project version
  - @Override Provider<String> gradleProperty(Object name, boolean configurationTimeSafety)
    
    Creates a provider to a project property.
    Parameters:
    name - Anything convertible to a string
    configurationTimeSafety - Whether this property can be read safely at configuration time. It is suggested to just use atConfigurationTime for this parameter
    Returns:
    Provider to the value of the project property.
  - @Override ReadableResource gzipResource(Object compressedFile)
    
    Creates resource that points to a gzip compressed file at the given path.
    Parameters:
    compressedFile - File evaluated as per file.
    Returns:
    Readable resource
  - @Override boolean isConfigurationCacheEnabled()
    
    Whether configuration cache is enabled for a build.
    Returns:
    true is configuration cache is available and enabled.
  - @Override boolean isOffline()
    
    Whether Gradle is operating in offline mode.
    Returns:
    true if offline.
  - @Override boolean isRefreshDependencies()
    
    Whether dependencies should be refreshed.
    Returns:
    true to check dependencies again.
  - @Override boolean isRerunTasks()
    
    Whether tasks should be re-ruin
    Returns:
    true if tasks were set to be re-run.
  - @Override boolean isRoot()
    
    Whether current project is the root project.
    Returns:
    true is current project is root project.
    Since:
    1.2
  - @Override ExecResult javaexec(Action<? super JavaExecSpec> action)
    
    Executes the specified external java process.
    Parameters:
    action
    Returns:
    ExecResult that can be used to check if the execution worked.
  - @Override String relativePath(Object f)
    
    Returns the relative path from the project directory to the given path.
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - @Override Provider<String> resolveProperty(Object name, Object defaultValue, boolean configurationTimeSafety)
    
    Searches by Gradle property, then system property and finally by environment variable using the PropertyResolver convention.
    Parameters:
    name - Anything convertible to a string
    defaultValue - Default value to return if the property search order does not return any value. Can be null. Anything convertible to a string.
    configurationTimeSafety - Whether this property can be read safely at configuration time. It is suggested to just use atConfigurationTime for this parameter.
    Returns:
    Provider to finding a property by the specified name.
  - @Override Provider<String> systemProperty(Object name, boolean configurationTimeSafety)
    
    Creates a provider to a system property.
    Parameters:
    name - Anything convertible to a string
    configurationTimeSafety - Whether this property can be read safely at configuration time. It is suggested to just use atConfigurationTime for this parameter
    Returns:
    Provider to the value of the system property.
  - @Override FileTree tarTree(Object tarPath)
    
    Returns a TAR tree presentation
    Parameters:
    tarPath - Path to tar file
    Returns:
    File tree
  - @Override void updateFileProperty(Provider<File> provider, Object file)
    
    Updates a file provider.
    Update property or otherwise the provider will be assigned a new Provider instance.
    Parameters:
    provider - Current property
    file - Value that should be lazy-resolved to a file using file.
  - @Override void updateStringProperty(Provider<String> provider, Object str)
    
    Updates a string provider.
    Update property or otherwise the provider will be assigned a new Provider instance.
    Parameters:
    provider - Current property
    str - Value that should be lazy-resolved to a string .
  - @Override FileTree zipTree(Object zipPath)
    
    Returns a ZIP tree presentation
    Parameters:
    zipPath - Path to zip file
    Returns:
    File tree

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class ProjectOperationsProxy

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected ProjectOperationsProxy(Project tempProjectReference)

Method Detail

@Override ReadableResource bzip2Resource(Object compressedFile)

@Override WorkResult copy(Action<? super CopySpec> action)

@Override boolean delete(Object... paths)

@Override WorkResult delete(Action<? super DeleteSpec> action)

@Override Provider<String> environmentVariable(Object name, boolean configurationTimeSafety)

@Override ExecResult exec(Action<? super ExecSpec> action)

@Override File file(Object path)

@Override File fileOrNull(Object file)

@Override java.util.List<File> fileize(Iterable<Object> files)

@Override FileCollection files(Object... paths)

protected org.ysb33r.grolifant.api.core.ArchiveOperationsProxy getArchiveOperations()

@Override ConsoleOutput getConsoleOutput()

protected org.ysb33r.grolifant.api.core.ExecOperationsProxy getExecOperations()

@Override org.ysb33r.grolifant.api.core.ExecTools getExecTools()

@Override @Deprecated ExtensionContainer getExtensions()

@Override org.ysb33r.grolifant.api.core.FileSystemOperations getFsOperations()

@Override String getFullProjectPath()

@Override LogLevel getGradleLogLevel()

@Override Provider<File> getGradleUserHomeDir()

@Override Provider<String> getGroupProvider()

org.ysb33r.grolifant.api.core.JvmTools getJvmTools()

@Override File getProjectDir()

@Override String getProjectName()

@Override String getProjectPath()

@Override File getProjectRootDir()

@Override org.ysb33r.grolifant.api.core.ProjectTools getProjectTools()

protected org.ysb33r.grolifant.api.core.GradleSysEnvProvider getPropertyProvider()

@Override org.ysb33r.grolifant.api.core.ProviderTools getProviderTools()

@Override ProviderFactory getProviders()

@Override org.ysb33r.grolifant.api.core.RepositoryTools getRepositoryTools()

@Override org.ysb33r.grolifant.api.core.StringTools getStringTools()

@Override org.ysb33r.grolifant.api.core.TaskTools getTasks()

@Override Provider<String> getVersionProvider()

@Override Provider<String> gradleProperty(Object name, boolean configurationTimeSafety)

@Override ReadableResource gzipResource(Object compressedFile)

@Override boolean isConfigurationCacheEnabled()

@Override boolean isOffline()

@Override boolean isRefreshDependencies()

@Override boolean isRerunTasks()

@Override boolean isRoot()

@Override ExecResult javaexec(Action<? super JavaExecSpec> action)

@Override String relativePath(Object f)

@Override Provider<String> resolveProperty(Object name, Object defaultValue, boolean configurationTimeSafety)

@Override Provider<String> systemProperty(Object name, boolean configurationTimeSafety)

@Override FileTree tarTree(Object tarPath)

@Override void updateFileProperty(Provider<File> provider, Object file)

@Override void updateStringProperty(Provider<String> provider, Object str)

@Override FileTree zipTree(Object zipPath)