org.netbeans.modules.gradle.api.execute

Class GradleDistributionManager.GradleDistribution

java.lang.Object

org.netbeans.modules.gradle.api.execute.GradleDistributionManager.GradleDistribution

All Implemented Interfaces:

Comparable<GradleDistributionManager.GradleDistribution>

Enclosing class:

GradleDistributionManager

public final class GradleDistributionManager.GradleDistribution
extends Object
implements Comparable<GradleDistributionManager.GradleDistribution>

This object represents a Gradle distribution in NetBeans combining the following four attributes:

• Gradle user home
• Distribution directory
• Gradle version
• Gradle distribution URI

Method Summary

Modifier and Type	Method and Description
int	compareTo(GradleDistributionManager.GradleDistribution o) This method only compare the version attribute.
boolean	equals(Object obj)
File	getDistributionDir() The Gradle distribution directory.
URI	getDistributionURI() The Gradle distribution URI.
File	getGradleUserHome() The Gradle user home directory of this distribution.
String	getVersion() The Gradle version of this distribution.
int	hashCode()
Future<Void>	install() Start to download and install this distribution from its distribution URI to its distribution directory asynchronous.
boolean	isAvailable() Checks if this distribution is downloaded and available to use.
boolean	isBlackListed() Checks if this distribution has known issues to be used with NetBeans.
boolean	isCompatibleWithJava(int jdkMajorVersion) Checks if this Gradle distribution is compatible with the given major version of Java.
boolean	isCompatibleWithSystemJava() Deprecated. shall be no reason to be used.
int	lastSupportedJava() Returns the newest major JDK version that is supported with this distribution.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getGradleUserHome

public File getGradleUserHome()

The Gradle user home directory of this distribution. Inherited through the GradleDistributionManager.

Returns:

the Gradle user home directory of this distribution

getDistributionDir

public File getDistributionDir()

The Gradle distribution directory. May or may not exists yet. If it does not exist then the GradleDistributionManager.GradleDistribution.getDistributionURI() must return a valid URI to the distribution source.

Returns:

the Gradle distribution directory

getDistributionURI

public URI getDistributionURI()

The Gradle distribution URI. It may return null if this is a manually installed distribution. In that case the GradleDistributionManager.GradleDistribution.getDistributionDir() shall return an existing distribution directory.

Returns:

the Gradle distribution URI

getVersion

public String getVersion()

The Gradle version of this distribution.

Returns:

the Gradle version of this distribution

isCompatibleWithJava

public boolean isCompatibleWithJava(int jdkMajorVersion)

Checks if this Gradle distribution is compatible with the given major version of Java. Java 1.6, 1.7 and 1.8 are treated as major version 6, 7, and 8.

NetBeans uses a built in fixed list of compatibility matrix. That means it might not know about the compatibility of newer Gradle versions. Optimistic bias would return true on these versions form 2.37.

Parameters:

jdkMajorVersion - the major version of the JDK

Returns:

true if this version is supported with that JDK.

lastSupportedJava

public int lastSupportedJava()

Returns the newest major JDK version that is supported with this distribution.

Returns:

the newest major JDK version that is supported with this distribution.

Since:

2.22

isCompatibleWithSystemJava

@Deprecated
public boolean isCompatibleWithSystemJava()

Deprecated. shall be no reason to be used.

Checks if this Gradle distribution is compatible the NetBeans runtime JDK.

Returns:

true.

isAvailable

public boolean isAvailable()

Checks if this distribution is downloaded and available to use. Well the current check is based on if the distribution directory exists or not.

Returns:

if this distribution is available for use.

isBlackListed

public boolean isBlackListed()

Checks if this distribution has known issues to be used with NetBeans. While these versions can be used, their usage are not recommended..

Returns:

if this distribution has compatibility issues with NetBeans.

install

public Future<Void> install()

Start to download and install this distribution from its distribution URI to its distribution directory asynchronous. It returns null if this distribution is available.

The install task has UI bindings in form of a IDE progress bar and notification entry on the downloading of the distribution.

Returns:

the Future of the install task or null if this distribution is already installed.

compareTo

public int compareTo(GradleDistributionManager.GradleDistribution o)

This method only compare the version attribute. It could happen that two distribution are equal using this method when their versions are equal, though the GradleDistributionManager.GradleDistribution.equals(java.lang.Object) return false as that is based on comparing the distribution directory.

Specified by:

compareTo in interface Comparable<GradleDistributionManager.GradleDistribution>

Parameters:

o - the GradleDistribution to compare with.

Returns:

a signed value comparing the version attribute of this and the specified distribution.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object