MutableToolExecSpec (grolifant-compat3 1.1.0-alpha.2 API)

Methods for setting executables and arguments.
Authors:
Schalk W. Cronjé
Since:
0.17.0

Properties Summary

Properties
Type	Name and description
`Iterable<?>`	`exeArgs`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exeArgs(Iterable<?> args)` Add more tool-specific arguments.
	`void`	`exeArgs(Object... args)` Add more tool-specific arguments.
	`void`	`executable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the exe.
	`ProcessForkOptions`	`executable(ResolvableExecutable resolver)` Set the exe to use.
	`java.util.List<String>`	`getExeArgs()` Any arguments specific to the tool in use
	`ResolvableExecutable`	`getResolvableExecutable()` Lazy-evaluated version of the exe
	`void`	`setExeArgs(Iterable<?> args)` Replace the tool-specific arguments with a new set.
	`void`	`setExecutable(String exe)` Set the exe to use.
	`void`	`setExecutable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the exe.
	`void`	`setExecutable(ResolvableExecutable resolver)` Set the exe to use.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec`	org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setWorkingDir(java.io.File), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#errorOutput(java.io.OutputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#standardInput(java.io.InputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#ignoreExitValue(boolean), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#standardOutput(java.io.OutputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setStandardOutput(java.io.OutputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setErrorOutput(java.io.OutputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setIgnoreExitValue(boolean), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setStandardInput(java.io.InputStream), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#isIgnoreExitValue(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getStandardOutput(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getErrorOutput(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getCommandLine(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getStandardInput(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setWorkingDir(java.lang.Object), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#workingDir(java.lang.Object), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getWorkingDir(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getEnvironment(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setEnvironment(java.util.Map), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#getExecutable(), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#copyTo(org.gradle.process.ProcessForkOptions), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#executable(java.lang.Object), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setExecutable(java.lang.String), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#setExecutable(java.lang.Object), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#environment(java.util.Map), org.ysb33r.grolifant.api.v4.exec.MutableBaseExecSpec#environment(java.lang.String, java.lang.Object)

- Property Detail
  - Iterable<?> exeArgs
- Method Detail
  - public void exeArgs(Iterable<?> args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - public void exeArgs(Object... args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - public void executable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the exe. In the default implementation only path and search are supported as a declarative keys. Implementations should use ResolverFactoryRegistry to add more keys.
    Parameters:
    exe - Key-value setting exe (with optional extra keys)
  - public ProcessForkOptions executable(ResolvableExecutable resolver)
    
    Set the exe to use.
    Parameters:
    resolver - An implementation of ResolvableExecutable
    Returns:
    This object as an instance of ProcessForkOptions
  - public java.util.List<String> getExeArgs()
    
    Any arguments specific to the tool in use
    Returns:
    Arguments to the tool. Can be empty, but never null.
  - public ResolvableExecutable getResolvableExecutable()
    
    Lazy-evaluated version of the exe
    Returns:
    Lazy-evaluated version of the exe or null if not configured.
  - public void setExeArgs(Iterable<?> args)
    
    Replace the tool-specific arguments with a new set.
    Parameters:
    args - New list of tool-specific arguments
  - public void setExecutable(String exe)
    
    Set the exe to use.
    This variant of the method has been introduced to cope with the API change in Gradle 4.0.
    Parameters:
    exe - Executable as String representation
  - public void setExecutable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the exe. In the default implementation only path and search are supported as a declarative keys. Implementations should use ResolverFactoryRegistry to add more keys.
    Parameters:
    exe - Key-value setting exe (with optional extra keys)
  - public void setExecutable(ResolvableExecutable resolver)
    
    Set the exe to use.
    Parameters:
    resolver - An implementation of ResolvableExecutable

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Java] Interface MutableToolExecSpec

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

Iterable<?> exeArgs

Method Detail

public void exeArgs(Iterable<?> args)

public void exeArgs(Object... args)

public void executable(java.util.Map<String, Object> exe)

public ProcessForkOptions executable(ResolvableExecutable resolver)

public java.util.List<String> getExeArgs()

public ResolvableExecutable getResolvableExecutable()

public void setExeArgs(Iterable<?> args)

public void setExecutable(String exe)

public void setExecutable(java.util.Map<String, Object> exe)

public void setExecutable(ResolvableExecutable resolver)