ProjectOperations (Grolifant Core API)

```
public interface ProjectOperations
```
Provides various operations which typically would require the Project or ProjectLayout instances to resolve.
Since:
1.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Provider<ProjectOperations>`	`asProvider()` A provider to this instance.
	`public boolean`	`atConfigurationTime()` Value that can be read safely at configuration time
	`public Provider<File>`	`buildDirDescendant(Object stringy)` Safely resolve the stringy item as a path relative to the build directory.
	`public ReadableResource`	`bzip2Resource(Object file)` Creates resource that points to a bzip2 compressed file at the given path.
	`public CopySpec`	`copySpec()` Creates an empty CopySpec.
	`public CopySpec`	`copySpec(Action<? super CopySpec> action)` Creates a CopySpec which can later be used to copy files or create an archive.
	`public static ProjectOperations`	`create(Project project)` Creates a reference to ProjectOperations instance.
	`public WorkResult`	`delete(Action<? super DeleteSpec> action)` Deletes the specified files.
	`public Provider<String>`	`environmentVariable(Object name)` Creates a provider to an environmental variable.
	`public Provider<String>`	`environmentVariable(Object name, boolean configurationTimeSafety)` Creates a provider to an environmental variable.
	`public ExecResult`	`exec(Action<? super ExecSpec> action)` Executes the specified external process.
	`public ConfigurableFileTree`	`fileTree(Object base)` Creates a new ConfigurableFileTree.
	`public static ProjectOperations`	`find(Project project)` Attempts to find the extension.
	`public Provider<File>`	`getBuildDir()` Provider for the build directory.
	`public ConfigurationTools`	`getConfigurations()` Tools to deal with Gradle configurations.
	`public ConsoleOutput`	`getConsoleOutput()` Console output mode
	`public ExecTools`	`getExecTools()` Tools to deal with out-of-process, non-JVM, executables.
	`public FileSystemOperations`	`getFsOperations()` Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.
	`public String`	`getFullProjectPath()` Get the full project path including the root project name in case of a multi-project.
	`public Provider<File>`	`getGradleHomeDir()` Gradle distribution home directory.
	`public LogLevel`	`getGradleLogLevel()` Get the minimum log level for Gradle.
	`public Provider<File>`	`getGradleUserHomeDir()` Gradle user home directory.
	`public Provider<String>`	`getGroupProvider()` Lazy-evaluated project group.
	`public JvmTools`	`getJvmTools()` Tools for dealing for JVM/Java operations.
	`public File`	`getProjectCacheDir()` Returns the project cache directory for the given project.
	`public File`	`getProjectDir()` Returns the project directory.
	`public String`	`getProjectName()` The project name
	`public String`	`getProjectPath()` Get project path.
	`public File`	`getProjectRootDir()` Returns the root directory of the project.
	`public ProjectTools`	`getProjectTools()` Tools to deal with project & configuration specifics down to Gradle 4.0.
	`public ProviderTools`	`getProviderTools()` Tools to deal with provider down to Gradle 4.0.
	`public ProviderFactory`	`getProviders()` A reference to the provider factory.
	`public RepositoryTools`	`getRepositoryTools()` Tools for dealing with repositories.
	`public StringTools`	`getStringTools()` Tools for dealing with conversions of various objects into string or lists of strings.
	`public TaskTools`	`getTasks()` Utilities for working with tasks in a consistent manner across Gradle versions.
	`public Provider<String>`	`getVersionProvider()` Lazy-evaluated project version.
	`public Provider<String>`	`gradleProperty(Object name)` Creates a provider to a project property.
	`public Provider<String>`	`gradleProperty(Object name, boolean configurationTimeSafety)` Creates a provider to a project property.
	`public ReadableResource`	`gzipResource(Object file)` Creates resource that points to a gzip compressed file at the given path.
	`public boolean`	`isConfigurationCacheEnabled()` Whether configuration cache is enabled for a build.
	`public boolean`	`isOffline()` Whether Gradle is operating in offline mode.
	`public boolean`	`isRefreshDependencies()` Whether dependencies should be refreshed.
	`public boolean`	`isRerunTasks()` Whether tasks should be re-ruin
	`public boolean`	`isRoot()` Whether current project is the root project.
	`public ExecResult`	`javaexec(Action<? super JavaExecSpec> action)` Executes the specified external java process.
	`public static ProjectOperations`	`maybeCreateExtension(Project project)` Creates a `grolifant` extension if it does not exist.
`<T>`	`public Provider<T>`	`provider(java.util.concurrent.Callable<? extends T> var1)` Returns a provider.
	`public Provider<String>`	`resolveProperty(Object name)` Searches by Gradle property, then system property and finally by environment variable using the `PropertyResolver convention`.
	`public Provider<String>`	`resolveProperty(Object name, boolean configurationTimeSafety)` Searches by Gradle property, then system property and finally by environment variable using the `PropertyResolver convention`.
	`public Provider<String>`	`resolveProperty(Object name, Object defaultValue)` Searches by Gradle property, then system property and finally by environment variable using the `PropertyResolver convention`.
	`public 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`.
	`public void`	`setVersionProvider(Object newVersion)` Sets a new version for a project.
	`public Provider<String>`	`systemProperty(Object name)` Creates a provider to a system property.
	`public Provider<String>`	`systemProperty(Object name, boolean configurationTimeSafety)` Creates a provider to a system property.
	`public FileTree`	`tarTree(Object tarPath)` Returns a TAR tree presentation
	`public FileTree`	`zipTree(Object zipPath)` Returns a ZIP tree presentation

- Method Detail
  - public Provider<ProjectOperations> asProvider()
    
    A provider to this instance.
    Returns:
    Provider.
  - public boolean atConfigurationTime()
    
    Value that can be read safely at configuration time
    As from Gradle 8.0, methods take this as an input, will ignore this value as all providers that can be resolved at configuration-time are available.
    Returns:
    Always returns true
    Since:
    1.1.0
  - public Provider<File> buildDirDescendant(Object stringy)
    
    Safely resolve the stringy item as a path relative to the build directory.
    Shortcut to getFsOperations().FileSystemOperations.buildDirDescendant. Use the latter where possible.
    
    Parameters:
    stringy - Any item that can be resolved to a string using org.ysb33r.grolifant5.core.api.grolifant.StringTools#stringize.
    Returns:
    Provider to a file
  - @Deprecated public ReadableResource bzip2Resource(Object file)
    
    Creates resource that points to a bzip2 compressed file at the given path.
    deprecated:
    Use getFsOperations().FileSystemOperations.bzip2Resource
    
    Parameters:
    file - File evaluated as per getFsOperations().FileSystemOperations.file.
    Returns:
    Readable resource
  - public CopySpec copySpec()
    
    Creates an empty CopySpec.
    Returns:
    CopySpec
  - public CopySpec copySpec(Action<? super CopySpec> action)
    
    Creates a CopySpec which can later be used to copy files or create an archive. The given action is used to configure the CopySpec before it is returned by this method.
    Parameters:
    action - Action to configure the CopySpec
    Returns:
    The CopySpec
  - @Deprecated public static ProjectOperations create(Project project)
    
    Creates a reference to ProjectOperations instance.
    deprecated:
    Apply the GrolifantServicePlugin instead.
    
    Parameters:
    project - Contextual project
    Returns:
    Extension.
  - public WorkResult delete(Action<? super DeleteSpec> action)
    
    Deletes the specified files. The given action is used to configure a DeleteSpec, which is then used to delete the files.
    Example:
```
 project.delete {
     delete 'somefile'
     followSymlinks = true
 }
 
```
    Parameters:
    action - Action to configure the DeleteSpec
    Returns:
    WorkResult that can be used to check if delete did any work.
  - public Provider<String> environmentVariable(Object name)
    
    Creates a provider to an environmental variable.
    Parameters:
    name - Anything convertible to a string
    Returns:
    Provider to the value of the an environmental variable. The property cannot safely be read at configuration time.
    Since:
    1.1.0
  - public 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. As from Gradle 8.0 this value is ignored.
    Returns:
    Provider to the value of an environment variable.
  - @Deprecated public ExecResult exec(Action<? super ExecSpec> action)
    
    Executes the specified external process.
    deprecated:
    Use getExecTools().ExecTools.exec instead.
    
    Parameters:
    action
    Returns:
    ExecResult that can be used to check if the execution worked.
  - public ConfigurableFileTree fileTree(Object base)
    
    Creates a new ConfigurableFileTree. The tree will have no base dir specified.
    Parameters:
    base - Base directory for file tree,
    Returns:
    File tree.
  - public static ProjectOperations find(Project project)
    
    Attempts to find the extension.
    Do not call this method once the configuration phase has finished.
    Parameters:
    project - Contextual project
    Returns:
    Extension
  - public Provider<File> getBuildDir()
    
    Provider for the build directory.
    Returns:
    Build directory.
  - public ConfigurationTools getConfigurations()
    
    Tools to deal with Gradle configurations.
    Returns:
  - public ConsoleOutput getConsoleOutput()
    
    Console output mode
    Returns:
    How the console output has been requested.
  - public ExecTools getExecTools()
    
    Tools to deal with out-of-process, non-JVM, executables.
    Returns:
    Tools instance optimised for current version of Gradle (where possible).
  - public FileSystemOperations getFsOperations()
    
    Returns an object instance for filesystem operations that deals coprrectly with the functionality of the curretn Gradle version.
    Returns:
    Instance of FileSystemOperations
  - public 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
  - public Provider<File> getGradleHomeDir()
    
    Gradle distribution home directory.
    Shortcut for getFsOperations().FileSystemOperations.getGradleHomeDir. It is recommended to use the latter, unless this is access directly from a buildscript.
    
    Returns:
    Directory.
    Since:
    2.2
  - public LogLevel getGradleLogLevel()
    
    Get the minimum log level for Gradle.
    Returns:
    Log level
  - public Provider<File> getGradleUserHomeDir()
    
    Gradle user home directory. Usually ~/.gradle on non -Windows.
    Shortcut for getFsOperations().FileSystemOperations.getGradleUserHomeDir. It is recommended to use the latter, unless this is access directly from a buildscript.
    
    Returns:
    Directory.
  - public Provider<String> getGroupProvider()
    
    Lazy-evaluated project group.
    Returns:
    provider to project group
  - public JvmTools getJvmTools()
    
    Tools for dealing for JVM/Java operations.
    Returns:
    Appropriate instance for the running Gradle version.
  - public File getProjectCacheDir()
    
    Returns the project cache directory for the given project.
    Shortcut for getFsOperations().FileSystemOperations.getProjectCacheDir. It is recommended to use the latter, unless this is access directly from a buildscript.
    
    Returns:
    Project cache directory. Never null.
  - public File getProjectDir()
    
    Returns the project directory.
    Shortcut for getFsOperations().FileSystemOperations.getProjectDir. It is recommended to use the latter, unless this is access directly from a buildscript.
    
    Returns:
    Project directory.
    Since:
    1.0
  - public String getProjectName()
    
    The project name
    Returns:
    Cached value of project name.
  - public String getProjectPath()
    
    Get project path.
    Returns:
    The fully qualified project path.
    Since:
    1.2
  - public File getProjectRootDir()
    
    Returns the root directory of the project.
    Returns:
    Root directory.
    Since:
    2.0
  - public 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).
    Since:
    2.0
  - public ProviderTools getProviderTools()
    
    Tools to deal with provider down to Gradle 4.0.
    Returns:
    Tools instance optimised for current version of Gradle (where possible).
  - public ProviderFactory getProviders()
    
    A reference to the provider factory.
    Returns:
    ProviderFactory
  - public RepositoryTools getRepositoryTools()
    
    Tools for dealing with repositories.
    Returns:
    Tools instance.
    Since:
    2.0
  - public StringTools getStringTools()
    
    Tools for dealing with conversions of various objects into string or lists of strings.
    Returns:
    String tools instance.
    Since:
    2.0
  - public TaskTools getTasks()
    
    Utilities for working with tasks in a consistent manner across Gradle versions.
    Returns:
    TaskTools instance.
    Since:
    1.3
  - public Provider<String> getVersionProvider()
    
    Lazy-evaluated project version.
    Returns:
    Provider to project version
  - public Provider<String> gradleProperty(Object name)
    
    Creates a provider to a project property.
    Parameters:
    name - Anything convertible to a string
    Returns:
    Provider to the value of the project property. The property cannot safely be read at configuration time
    Since:
    1.1.0
  - public 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. As from Gradle 8.0 this value is ignored.
    Returns:
    Provider to the value of the project property.
  - @Deprecated public ReadableResource gzipResource(Object file)
    
    Creates resource that points to a gzip compressed file at the given path.
    deprecated:
    Use getFsOperations().FileSystemOperations.gzipResource
    
    Parameters:
    file - File evaluated as pergetFsOperations().FileSystemOperations.file.
    Returns:
    Readable resource
  - public boolean isConfigurationCacheEnabled()
    
    Whether configuration cache is enabled for a build.
    Returns:
    true is configuration cache is available and enabled.
  - public boolean isOffline()
    
    Whether Gradle is operating in offline mode.
    Returns:
    true if offline.
  - public boolean isRefreshDependencies()
    
    Whether dependencies should be refreshed.
    Returns:
    true to check dependencies again.
  - public boolean isRerunTasks()
    
    Whether tasks should be re-ruin
    Returns:
    true if tasks were set to be re-run.
  - public boolean isRoot()
    
    Whether current project is the root project.
    Returns:
    true is current project is root project.
    Since:
    1.2
  - @Deprecated public ExecResult javaexec(Action<? super JavaExecSpec> action)
    
    Executes the specified external java process.
    deprecated:
    Use getExecTools().ExecTools.javaexec instead
    
    Parameters:
    action
    Returns:
    ExecResult that can be used to check if the execution worked.
  - @Deprecated public static ProjectOperations maybeCreateExtension(Project project)
    
    Creates a grolifant extension if it does not exist.
    deprecated:
    Apply the GrolifantServicePlugin instead.
    
    Parameters:
    project - Contextual project
    Returns:
    Extension.
  - <T> public Provider<T> provider(java.util.concurrent.Callable<? extends T> var1)
    
    Returns a provider.
    Parameters:
    var1 - Anything that adheres to a Callable including Groovy closures or Java lambdas.
    Returns:
    Provider instance.
  - public Provider<String> resolveProperty(Object name)
    
    Searches by Gradle property, then system property and finally by environment variable using the PropertyResolver convention.
    Parameters:
    name - Anything convertible to a string
    Returns:
    Provider to finding a property by the specified name. The property cannot safely be read at configuration time.
  - public Provider<String> resolveProperty(Object name, 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
    configurationTimeSafety - Whether this property can be read safely at configuration time. It is suggested to just use atConfigurationTime for this parameter. As from Gradle 8.0 this value is ignored.
    Returns:
    Provider to finding a property by the specified name.
  - public Provider<String> resolveProperty(Object name, Object defaultValue)
    
    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.
    Returns:
    Provider to finding a property by the specified name. The property cannot safely be read at configuration time.
  - public 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.
    Shortcut to getProviderTools().ProviderTools.resolveProperty.
    
    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. As from Gradle 8.0 this value is ignored.
    Returns:
    Provider to finding a property by the specified name.
  - public void setVersionProvider(Object newVersion)
    
    Sets a new version for a project.
    This creates an internal objhect that can safely be evaluated by Gradle's Project.getVersion.
    
    Parameters:
    newVersion - Anything that can be converted to a string using StringTools.
  - public Provider<String> systemProperty(Object name)
    
    Creates a provider to a system property.
    Shortcut to getProviderTools().ProviderTools.systemProperty.
    
    Parameters:
    name - Anything convertible to a string
    Returns:
    Provider to the value of the system property. The property cannot safely be read at configuration time
    Since:
    1.1.0
  - public Provider<String> systemProperty(Object name, boolean configurationTimeSafety)
    
    Creates a provider to a system property.
    Shortcut to getProviderTools().ProviderTools.systemProperty.
    
    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. As from Gradle 8.0 this value is ignored.
    Returns:
    Provider to the value of the system property.
  - @Deprecated public FileTree tarTree(Object tarPath)
    
    Returns a TAR tree presentation
    Shortcut for getFsOperations().FileSystemOperations.tarTree. It is recommended to use the latter, unless this is access directly from a buildscript.
    deprecated:
    
    Parameters:
    tarPath - Path to tar file
    Returns:
    File tree
  - @Deprecated public FileTree zipTree(Object zipPath)
    
    Returns a ZIP tree presentation
    Shortcut for getFsOperations().FileSystemOperations.zipTree. It is recommended to use the latter, unless this is access directly from a buildscript.
    deprecated:
    
    Parameters:
    zipPath - Path to zip file
    Returns:
    File tree

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface ProjectOperations

Methods Summary

Method Detail

public Provider<ProjectOperations> asProvider()

public boolean atConfigurationTime()

public Provider<File> buildDirDescendant(Object stringy)

@Deprecated public ReadableResource bzip2Resource(Object file)

public CopySpec copySpec()

public CopySpec copySpec(Action<? super CopySpec> action)

@Deprecated public static ProjectOperations create(Project project)

public WorkResult delete(Action<? super DeleteSpec> action)

public Provider<String> environmentVariable(Object name)

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

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

public ConfigurableFileTree fileTree(Object base)

public static ProjectOperations find(Project project)

public Provider<File> getBuildDir()

public ConfigurationTools getConfigurations()

public ConsoleOutput getConsoleOutput()

public ExecTools getExecTools()

public FileSystemOperations getFsOperations()

public String getFullProjectPath()

public Provider<File> getGradleHomeDir()

public LogLevel getGradleLogLevel()

public Provider<File> getGradleUserHomeDir()

public Provider<String> getGroupProvider()

public JvmTools getJvmTools()

public File getProjectCacheDir()

public File getProjectDir()

public String getProjectName()

public String getProjectPath()

public File getProjectRootDir()

public ProjectTools getProjectTools()

public ProviderTools getProviderTools()

public ProviderFactory getProviders()

public RepositoryTools getRepositoryTools()

public StringTools getStringTools()

public TaskTools getTasks()

public Provider<String> getVersionProvider()

public Provider<String> gradleProperty(Object name)

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

@Deprecated public ReadableResource gzipResource(Object file)

public boolean isConfigurationCacheEnabled()

public boolean isOffline()

public boolean isRefreshDependencies()

public boolean isRerunTasks()

public boolean isRoot()

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

@Deprecated public static ProjectOperations maybeCreateExtension(Project project)

<T> public Provider<T> provider(java.util.concurrent.Callable<? extends T> var1)

public Provider<String> resolveProperty(Object name)

public Provider<String> resolveProperty(Object name, boolean configurationTimeSafety)

public Provider<String> resolveProperty(Object name, Object defaultValue)

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

public void setVersionProvider(Object newVersion)

public Provider<String> systemProperty(Object name)

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

@Deprecated public FileTree tarTree(Object tarPath)

@Deprecated public FileTree zipTree(Object zipPath)