org.netbeans.modules.gradle.spi.execute

Interface JavaRuntimeManager

public interface JavaRuntimeManager

JavaRuntimeManager is to provide Java Runtime for Gradle execution. Gradle is not just a build system for JVM based languages, but can build C, C++, NodeJS projects as well.

Gradle just requires a suitable JRE to run on.

Most cases though Gradle build Java libraries/applications, and by default Gradle uses the JVM, that it is running on.

This manager separates the JavaRuntime on which Gradle can run from the JavaPlatform on which Gradle Java project can be built. Every JavaPlatform is a JavaRuntime, but not every JavaRuntime is a JavaPlatform way.

Since:

2.32

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JavaRuntimeManager.JavaRuntime This class represents a java home directory with and id, and an optional display name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RUNTIME_ID The ID that the Runtime shall use for the Java Runtime the IDE is runnoing on.

Method Summary

Modifier and Type	Method and Description
default void	addChangeListener(ChangeListener l) Register a change listener to this manager.
static JavaRuntimeManager.JavaRuntime	createJavaRuntime(String id, File javaHome)
static JavaRuntimeManager.JavaRuntime	createJavaRuntime(String id, String displayName, File javaHome)
Map<String,JavaRuntimeManager.JavaRuntime>	getAvailableRuntimes() Return the available runtimes stored in the IDE with their respective Id-s.
default Optional<Runnable>	manageRuntimesAction() This method is called from the Gradle Execution Customizer when the "Manage Runtimes..." button is called.
default void	removeChangeListener(ChangeListener l) Removes a change listener from this manager.

Field Detail

DEFAULT_RUNTIME_ID

static final String DEFAULT_RUNTIME_ID

The ID that the Runtime shall use for the Java Runtime the IDE is runnoing on.

See Also:

Constant Field Values

Method Detail

getAvailableRuntimes

Map<String,JavaRuntimeManager.JavaRuntime> getAvailableRuntimes()

Return the available runtimes stored in the IDE with their respective Id-s.

Returns:

the available runtimes stored in the IDE.

manageRuntimesAction

default Optional<Runnable> manageRuntimesAction()

This method is called from the Gradle Execution Customizer when the "Manage Runtimes..." button is called.

Returns:

can provide a runnable to configure the available runtimes.

addChangeListener

default void addChangeListener(ChangeListener l)

Register a change listener to this manager. Implementations shall fire a change event when the available runtimes changed.

The default implementation does nothing.

Parameters:

l - the listener to be registered.

removeChangeListener

default void removeChangeListener(ChangeListener l)

Removes a change listener from this manager.

The default implementation does nothing.

Parameters:

l - the listener to be removed.

createJavaRuntime

static JavaRuntimeManager.JavaRuntime createJavaRuntime(@NonNull
                                                        String id,
                                                        File javaHome)

createJavaRuntime

static JavaRuntimeManager.JavaRuntime createJavaRuntime(@NonNull
                                                        String id,
                                                        String displayName,
                                                        File javaHome)