GradleUpdateResult (gradle-versions-plugin 0.35.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

com.github.benmanes.gradle.versions.updates.gradle.GradleUpdateResult

All Implemented Interfaces and Traits:

java.lang.Comparable
```
@groovy.transform.CompileStatic
class GradleUpdateResult
extends java.lang.Object
```
Holder class for gradle update results of a specific release channel (or the running version). Used for reporting & serialization to JSON/XML

Properties Summary

Properties
Type	Name and description
`boolean`	`isFailure` Indicates whether the check for Gradle updates on this release channel failed.
`boolean`	`isUpdateAvailable` Indicates whether the version is an update with respect to the currently running gradle version.
`java.lang.String`	`reason` An explanatory field on how to interpret the results.
`java.lang.String`	`version` The version available on the release channel represented by this object.

Constructor Summary

Constructors
Constructor and description
`GradleUpdateResult (boolean enabled, Available running, ReleaseStatus release)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`compareTo(GradleUpdateResult o)` Compares two instances of GradleUpdateResult.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final boolean isFailure
    
    Indicates whether the check for Gradle updates on this release channel failed.
  - final boolean isUpdateAvailable
    
    Indicates whether the version is an update with respect to the currently running gradle version.
  - final java.lang.String reason
    
    An explanatory field on how to interpret the results. Useful when version is not set to a valid value.
  - final java.lang.String version
    
    The version available on the release channel represented by this object.
- Constructor Detail
  - GradleUpdateResult(boolean enabled, Available running, ReleaseStatus release)
- Method Detail
  - @java.lang.Override int compareTo(GradleUpdateResult o)
    
    Compares two instances of GradleUpdateResult.
    throws:
    IllegalArgumentException when one of the GradleUpdateResults does not represent a valid org.gradle.util.GradleVersion. This may be the case when a GradleUpdateResult represents a failure.
    
    Parameters:
    o
    Returns:
    an integer as specified by Comparable#compareTo(java.lang.Object)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation