ProjectOperations (docs 2.0.2 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 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 WorkResult`	`copy(Action<? super CopySpec> action)` Performs a copy according to copy specification.
	`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)`
	`public boolean`	`delete(Object paths)` Deletes files and directories.
	`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 File`	`file(Object file)` Converts a file-like object to a File instance with project context.
	`public File`	`fileOrNull(Object file)` Similar to { Link: #file}, but does not throw an exception if the object is `null` or an empty provider.
	`public ConfigurableFileTree`	`fileTree(Object base)` Creates a new ConfigurableFileTree.
	`public java.util.List<File>`	`fileize(Iterable<Object> files)` Converts a collection of file-like objects to a list of File instances with project context.
	`public FileCollection`	`files(Object paths)`
	`public static ProjectOperations`	`find(Project project)` Attempts to find the extension.
	`public Provider<File>`	`getBuildDir()` Provider for the build directory.
	`public ConsoleOutput`	`getConsoleOutput()` Console output mode
	`public ExecTools`	`getExecTools()` Tools to deal with out-of-process, non-JVM, executables.
	`public ExtensionContainer`	`getExtensions()` Extensions container for the project.
	`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 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.
`<IN, OUT>`	`public Provider<OUT>`	`map(Provider<IN> base, Transformer<OUT, IN> transformer)` Maps one provider to another.
	`public static ProjectOperations`	`maybeCreateExtension(Project project)`
`<T>`	`public Provider<T>`	`provider(java.util.concurrent.Callable<? extends T> var1)` Returns a provider.
	`public String`	`relativePath(Object f)` Returns the relative path from the project directory to the given path.
	`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 void`	`updateFileProperty(Provider<File> provider, Object file)` Updates a file provider.
	`public void`	`updateStringProperty(Provider<String> provider, Object str)` Updates a string provider.
	`public FileTree`	`zipTree(Object zipPath)` Returns a ZIP tree presentation

- Method Detail
  - 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.
    Parameters:
    stringy - Any item that can be resolved to a string using org.ysb33r.grolifant.api.core.StringTools#stringize.
    Returns:
    Provider to a file
  - public ReadableResource bzip2Resource(Object file)
    
    Creates resource that points to a bzip2 compressed file at the given path.
    Parameters:
    file - File evaluated as per file.
    Returns:
    Readable resource
  - public WorkResult copy(Action<? super CopySpec> action)
    
    Performs a copy according to copy specification.
    Parameters:
    action - Copy specification
    Returns:
    Result of copy operation.
  - 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
  - public static ProjectOperations create(Project project)
  - public boolean delete(Object paths)
    
    Deletes files and directories.
    This will not follow symlinks. If you need to follow symlinks too use delete(Action).
    Parameters:
    paths - Any type of object accepted by Project.files
    Returns:
    true if anything got deleted, false otherwise
  - 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 the an environmental variable.
  - public 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.
  - @Deprecated public File file(Object file)
    
    Converts a file-like object to a File instance with project context.
    Converts any of the following recursively until it gets to a file:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path is it is associated with the default provider
    - URLs and URis of file: schemes.
    - Groovy Closures.
    - java.util.concurrent.Callable.
    - Provider.
    - Directory (Gradle 4.1+)
    - TextResource
    deprecated:
    Use FileSystemOperations.file from getFsOperations instead.
    
    Parameters:
    file - Potential File object
    Returns:
    File instance.
  - @Deprecated public File fileOrNull(Object file)
    
    Similar to {
    Link:
    #file}, but does not throw an exception if the object is null or an empty provider.
    deprecated:
    Use FileSystemOperations.fileOrNull from getFsOperations instead.
    
    Parameters:
    file - Potential File object
    Returns:
    File instance or null.
    Since:
    1.2
  - 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.
  - @Deprecated public 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.
    deprecated:
    USe FileSystemOperations.files instead.
    
    Parameters:
    files - List of object to evaluate
    Returns:
    List of resolved files.
  - @Deprecated public 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 FileSystemOperations.files instead.
    
    Parameters:
    paths - The paths to the files. May be empty.
    Returns:
    The file collection. Never returns null.
  - 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 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).
  - @Deprecated public ExtensionContainer getExtensions()
    
    Extensions container for the project.
    deprecated:
    Will be removed before 1.0 final release
    
    Returns:
    Reference to the extensions container
  - 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 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.
    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.
    Returns:
    Project cache directory. Never null.
  - public File getProjectDir()
    
    Returns the project directory.
    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.
  - public ReadableResource gzipResource(Object file)
    
    Creates resource that points to a gzip compressed file at the given path.
    Parameters:
    file - File evaluated as per 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
  - public 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.
  - <IN, OUT> public Provider<OUT> map(Provider<IN> base, Transformer<OUT, IN> transformer)
    
    Maps one provider to another. Use this method if you need to support Gradle 4.0 - 4.2 as part of compatibility.
    deprecated:
    Use getProviderTools().map instead.
    
    Parameters:
    base - Original provider
    transformer - Transforming function.
    Returns:
    New provider
  - public static ProjectOperations maybeCreateExtension(Project project)
  - <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.
  - @Deprecated public String relativePath(Object f)
    
    Returns the relative path from the project directory to the given path.
    deprecated:
    Use FileSystemOperations.relativePath from getFsOperations instead.
    
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - 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.
    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.
    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.
    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.
  - public FileTree tarTree(Object tarPath)
    
    Returns a TAR tree presentation
    Parameters:
    tarPath - Path to tar file
    Returns:
    File tree
  - @Deprecated public void updateFileProperty(Provider<File> provider, Object file)
    
    Updates a file provider.
    Update property or otherwise the provider will be assigned a new Provider instance.
    deprecated:
    Use FileSystemOperations.updateFileProperty instead.
    
    Parameters:
    provider - Current property
    file - Value that should be lazy-resolved to a file using file.
  - @Deprecated public void updateStringProperty(Provider<String> provider, Object str)
    
    Updates a string provider.
    Update property or otherwise the provider will be assigned a new Provider instance.
    deprecated:
    Use StringTools.updateStringProperty instead.
    
    Parameters:
    provider - Current property
    str - Value that should be lazy-resolved to a string .
  - public FileTree zipTree(Object zipPath)
    
    Returns a ZIP tree presentation
    Parameters:
    zipPath - Path to zip file
    Returns:
    File tree

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface ProjectOperations

Methods Summary

Method Detail

public boolean atConfigurationTime()

public Provider<File> buildDirDescendant(Object stringy)

public ReadableResource bzip2Resource(Object file)

public WorkResult copy(Action<? super CopySpec> action)

public CopySpec copySpec()

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

public static ProjectOperations create(Project project)

public boolean delete(Object paths)

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

public Provider<String> environmentVariable(Object name)

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

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

@Deprecated public File file(Object file)

@Deprecated public File fileOrNull(Object file)

public ConfigurableFileTree fileTree(Object base)

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

@Deprecated public FileCollection files(Object paths)

public static ProjectOperations find(Project project)

public Provider<File> getBuildDir()

public ConsoleOutput getConsoleOutput()

public ExecTools getExecTools()

@Deprecated public ExtensionContainer getExtensions()

public FileSystemOperations getFsOperations()

public String getFullProjectPath()

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)

public ReadableResource gzipResource(Object file)

public boolean isConfigurationCacheEnabled()

public boolean isOffline()

public boolean isRefreshDependencies()

public boolean isRerunTasks()

public boolean isRoot()

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

<IN, OUT> public Provider<OUT> map(Provider<IN> base, Transformer<OUT, IN> transformer)

public static ProjectOperations maybeCreateExtension(Project project)

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

@Deprecated public String relativePath(Object f)

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)

public FileTree tarTree(Object tarPath)

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

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

public FileTree zipTree(Object zipPath)