GradleDistribution (gradle-fixtures 0.0.52 API)

All Known Implementing Classes:

CurrentGradleDistribution, DefaultGradleDistribution, DownloadableGradleDistribution, ReleasedGradleDistribution
```
public interface GradleDistribution
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GradleExecuter`	`executer(TestFile testDirectoryProvider)` Creates an executer which will use this distribution.
`org.gradle.cache.internal.CacheVersion`	`getArtifactCacheLayoutVersion()` Returns the version of the artifact cache layout
`TestFile`	`getBinDistribution()` Returns the binary distribution.
`TestFile`	`getGradleHomeDir()` Returns the root directory of the installed distribution
`org.gradle.util.GradleVersion`	`getVersion()` Returns the version of this distribution.
`boolean`	`isAddsTaskExecutionExceptionAroundAllTaskFailures()` Returns true if this version always adds a task execution exception around all failures, such as input fingerprinting or property validation failures, rather than only around task action failures.
`boolean`	`isDaemonIdleTimeoutConfigurable()` Returns true if the configuring daemon idle timeout feature is supported by this distribution.
`boolean`	`isFullySupportsIvyRepository()` The 'ivy' repository was introduced in Milestone-3, but early versions didn't work with spaces in the artifact pattern.
`boolean`	`isSupportsSpacesInGradleAndJavaOpts()` Early versions had bugs that prevented any values having spaces in them in GRADLE_OPTS or JAVA_OPTS.
`boolean`	`isToolingApiDoesNotAddCausesOnTaskCancel()` Returns true if this version does not occasionally add additional 'build cancelled' exceptions when tasks are cancelled.
`boolean`	`isToolingApiHasCauseOnCancel()` Returns true if this version has a useful cause attached to the exception thrown by the tooling API client on build cancel.
`boolean`	`isToolingApiHasCauseOnForcedCancel()` Returns true if this version has a useful cause attached to the exception thrown by the tooling API client when daemon is killed to force cancellation.
`boolean`	`isToolingApiHasCauseOnPhasedActionFail()` Returns true if this version retains the original exception as cause on phased action fail.
`boolean`	`isToolingApiLocksBuildActionClasses()` Returns true if the tooling API of this distribution incorrectly locks build action implementation classes.
`boolean`	`isToolingApiLoggingInEmbeddedModeSupported()` Returns true if the tooling API of this distribution correctly handles logging in embedded mode.
`boolean`	`isToolingApiLogsConfigureSummary()` Returns true if this version logs different build outcome messages for tooling API requests that run tasks and to requests that do not run tasks (eg fetch a model).
`boolean`	`isToolingApiLogsFailureOnCancel()` Returns true if this version logs a 'build failed' message on build cancellation.
`boolean`	`isToolingApiMergesStderrIntoStdout()` Returns true if this version logs errors to stdout instead of stderr.
`boolean`	`isToolingApiRetainsOriginalFailureOnCancel()` Returns true if this version retains the original build failure on cancellation (with all context) in the client and build logging, rather than discarding contextual exceptions.
`boolean`	`isToolingApiStdinInEmbeddedModeSupported()` Returns true if this version handles the client provided standard input stream when running in embedded mode.
`boolean`	`isToolingApiSupported()` Returns true if the tooling API is supported by this distribution.
`boolean`	`isToolingApiTargetJvmSupported(org.gradle.api.JavaVersion javaVersion)` Returns true if the tooling API of this distribution supports the given target JVM.
`boolean`	`isWrapperSupportsGradleUserHomeCommandLineOption()` Returns true if the wrapper for this version honours the --gradle-user-home command-line option.
`<T> T`	`selectOutputWithFailureLogging(T stdout, T stderr)` Returns the logging output stream that this version logs build failures to when invoked via the tooling API.
`boolean`	`worksWith(org.gradle.internal.jvm.Jvm jvm)` Returns true if this distribution supports the given JVM.
`boolean`	`worksWith(org.gradle.internal.os.OperatingSystem os)` Returns true if this distribution supports the given Operating system.
`boolean`	`wrapperCanExecute(org.gradle.util.GradleVersion version)` Returns true if the wrapper from this distribution can execute a build using the specified version.

- Method Detail
  - getGradleHomeDir
```
TestFile getGradleHomeDir()
```
    Returns the root directory of the installed distribution
  - getBinDistribution
```
TestFile getBinDistribution()
```
    Returns the binary distribution.
  - getVersion
```
org.gradle.util.GradleVersion getVersion()
```
    Returns the version of this distribution.
  - executer
```
GradleExecuter executer(TestFile testDirectoryProvider)
```
    Creates an executer which will use this distribution.
  - worksWith
```
boolean worksWith(org.gradle.internal.jvm.Jvm jvm)
```
    Returns true if this distribution supports the given JVM.
  - worksWith
```
boolean worksWith(org.gradle.internal.os.OperatingSystem os)
```
    Returns true if this distribution supports the given Operating system.
  - isDaemonIdleTimeoutConfigurable
```
boolean isDaemonIdleTimeoutConfigurable()
```
    Returns true if the configuring daemon idle timeout feature is supported by this distribution.
  - isToolingApiSupported
```
boolean isToolingApiSupported()
```
    Returns true if the tooling API is supported by this distribution.
  - isToolingApiTargetJvmSupported
```
boolean isToolingApiTargetJvmSupported(org.gradle.api.JavaVersion javaVersion)
```
    Returns true if the tooling API of this distribution supports the given target JVM.
  - isToolingApiLoggingInEmbeddedModeSupported
```
boolean isToolingApiLoggingInEmbeddedModeSupported()
```
    Returns true if the tooling API of this distribution correctly handles logging in embedded mode.
  - isToolingApiStdinInEmbeddedModeSupported
```
boolean isToolingApiStdinInEmbeddedModeSupported()
```
    Returns true if this version handles the client provided standard input stream when running in embedded mode.
  - isToolingApiLocksBuildActionClasses
```
boolean isToolingApiLocksBuildActionClasses()
```
    Returns true if the tooling API of this distribution incorrectly locks build action implementation classes.
  - getArtifactCacheLayoutVersion
```
org.gradle.cache.internal.CacheVersion getArtifactCacheLayoutVersion()
```
    Returns the version of the artifact cache layout
  - wrapperCanExecute
```
boolean wrapperCanExecute(org.gradle.util.GradleVersion version)
```
    Returns true if the wrapper from this distribution can execute a build using the specified version.
  - isSupportsSpacesInGradleAndJavaOpts
```
boolean isSupportsSpacesInGradleAndJavaOpts()
```
    Early versions had bugs that prevented any values having spaces in them in GRADLE_OPTS or JAVA_OPTS. See https://issues.gradle.org/browse/GRADLE-1730
  - isFullySupportsIvyRepository
```
boolean isFullySupportsIvyRepository()
```
    The 'ivy' repository was introduced in Milestone-3, but early versions didn't work with spaces in the artifact pattern.
  - isWrapperSupportsGradleUserHomeCommandLineOption
```
boolean isWrapperSupportsGradleUserHomeCommandLineOption()
```
    Returns true if the wrapper for this version honours the --gradle-user-home command-line option.
  - isAddsTaskExecutionExceptionAroundAllTaskFailures
```
boolean isAddsTaskExecutionExceptionAroundAllTaskFailures()
```
    Returns true if this version always adds a task execution exception around all failures, such as input fingerprinting or property validation failures, rather than only around task action failures.
  - isToolingApiRetainsOriginalFailureOnCancel
```
boolean isToolingApiRetainsOriginalFailureOnCancel()
```
    Returns true if this version retains the original build failure on cancellation (with all context) in the client and build logging, rather than discarding contextual exceptions.
  - isToolingApiHasCauseOnCancel
```
boolean isToolingApiHasCauseOnCancel()
```
    Returns true if this version has a useful cause attached to the exception thrown by the tooling API client on build cancel.
  - isToolingApiDoesNotAddCausesOnTaskCancel
```
boolean isToolingApiDoesNotAddCausesOnTaskCancel()
```
    Returns true if this version does not occasionally add additional 'build cancelled' exceptions when tasks are cancelled.
  - isToolingApiHasCauseOnForcedCancel
```
boolean isToolingApiHasCauseOnForcedCancel()
```
    Returns true if this version has a useful cause attached to the exception thrown by the tooling API client when daemon is killed to force cancellation.
  - isToolingApiLogsFailureOnCancel
```
boolean isToolingApiLogsFailureOnCancel()
```
    Returns true if this version logs a 'build failed' message on build cancellation.
  - isToolingApiHasCauseOnPhasedActionFail
```
boolean isToolingApiHasCauseOnPhasedActionFail()
```
    Returns true if this version retains the original exception as cause on phased action fail.
  - isToolingApiMergesStderrIntoStdout
```
boolean isToolingApiMergesStderrIntoStdout()
```
    Returns true if this version logs errors to stdout instead of stderr.
  - selectOutputWithFailureLogging
```
<T> T selectOutputWithFailureLogging(T stdout,
                                     T stderr)
```
    Returns the logging output stream that this version logs build failures to when invoked via the tooling API.
  - isToolingApiLogsConfigureSummary
```
boolean isToolingApiLogsConfigureSummary()
```
    Returns true if this version logs different build outcome messages for tooling API requests that run tasks and to requests that do not run tasks (eg fetch a model).

Interface GradleDistribution

Method Summary

Method Detail

getGradleHomeDir

getBinDistribution

getVersion

executer

worksWith

worksWith

isDaemonIdleTimeoutConfigurable

isToolingApiSupported

isToolingApiTargetJvmSupported

isToolingApiLoggingInEmbeddedModeSupported

isToolingApiStdinInEmbeddedModeSupported

isToolingApiLocksBuildActionClasses

getArtifactCacheLayoutVersion

wrapperCanExecute

isSupportsSpacesInGradleAndJavaOpts

isFullySupportsIvyRepository

isWrapperSupportsGradleUserHomeCommandLineOption

isAddsTaskExecutionExceptionAroundAllTaskFailures

isToolingApiRetainsOriginalFailureOnCancel

isToolingApiHasCauseOnCancel

isToolingApiDoesNotAddCausesOnTaskCancel

isToolingApiHasCauseOnForcedCancel

isToolingApiLogsFailureOnCancel

isToolingApiHasCauseOnPhasedActionFail

isToolingApiMergesStderrIntoStdout

selectOutputWithFailureLogging

isToolingApiLogsConfigureSummary