net.covers1624.jdkutils

Class JavaInstall

java.lang.Object

net.covers1624.jdkutils.JavaInstall

public class JavaInstall
extends java.lang.Object

Defines properties and helpers for specific Java installations.

A JavaInstall can be extracted form a specific known Java installation using the parse(Path).

One can extract all known installed Java installations off a given System using JavaLocator and the associated Builder.

Concepts:
Installation Directory - A Java installation directory refers to the root directory of the java installation. This directory usually has the java version within its name. However, is not guaranteed.

Java Home - Java home in this context is defined as the location in which the bin folder containing Java executables can be found. On Linux and Windows, this is generally the same as the Installation Directory, However on macOs this is usually the Contents/Home/ folder within the Installation Directory.

Created by covers1624 on 30/10/21.

Field Summary

Fields

Modifier and Type	Field and Description
net.covers1624.quack.platform.Architecture	architecture
boolean	hasCompiler
java.lang.String	implName
java.lang.String	implVersion
boolean	isOpenJ9
java.nio.file.Path	javaHome
JavaVersion	langVersion
java.lang.String	runtimeName
java.lang.String	runtimeVersion
java.lang.String	vendor

Constructor Summary

Constructors

Constructor and Description
JavaInstall(java.nio.file.Path javaHome, java.lang.String vendor, java.lang.String implName, java.lang.String implVersion, java.lang.String runtimeName, java.lang.String runtimeVersion, net.covers1624.quack.platform.Architecture architecture)

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	getBinDirectory(java.nio.file.Path installationDir) Gets the bin directory for a given java installation.
static java.nio.file.Path	getExecutable(java.nio.file.Path homeDir, java.lang.String executable) Gets the given executable within the given java home directory.
static java.nio.file.Path	getHomeDirectory(java.nio.file.Path installationDir) Gets the Java home directory from a specific Installation.
static java.nio.file.Path	getJavaExecutable(java.nio.file.Path homeDir, boolean useJavaw) Gets the Java executable for a given home directory.
static @Nullable JavaInstall	parse(java.nio.file.Path executable) Execute the given Java executable, extracting information from it.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

langVersion

public final JavaVersion langVersion

javaHome

public final java.nio.file.Path javaHome

vendor

public final java.lang.String vendor

implName

public final java.lang.String implName

implVersion

public final java.lang.String implVersion

runtimeName

public final java.lang.String runtimeName

runtimeVersion

public final java.lang.String runtimeVersion

architecture

public final net.covers1624.quack.platform.Architecture architecture

isOpenJ9

public final boolean isOpenJ9

hasCompiler

public final boolean hasCompiler

Constructor Detail

JavaInstall

public JavaInstall(java.nio.file.Path javaHome,
                   java.lang.String vendor,
                   java.lang.String implName,
                   java.lang.String implVersion,
                   java.lang.String runtimeName,
                   java.lang.String runtimeVersion,
                   net.covers1624.quack.platform.Architecture architecture)

Method Detail

getBinDirectory

public static java.nio.file.Path getBinDirectory(java.nio.file.Path installationDir)

Gets the bin directory for a given java installation.

Parameters:

installationDir - The installation directory.

Returns:

The bin directory.

getHomeDirectory

public static java.nio.file.Path getHomeDirectory(java.nio.file.Path installationDir)

Gets the Java home directory from a specific Installation. This method uses the detected currently running Operating System to determine how to transform the given Installation Directory into a Java Home Directory and is not stable across Operating Systems.

Parameters:

installationDir - The installation directory.

Returns:

The Java home.

getJavaExecutable

public static java.nio.file.Path getJavaExecutable(java.nio.file.Path homeDir,
                                                   boolean useJavaw)

Gets the Java executable for a given home directory.

Parameters:

homeDir - The java home directory.

useJavaw - If javaw should be used on Windows instead of java.

Returns:

The executable.

See Also:

Root javadoc contains definitions for homeDir

getExecutable

public static java.nio.file.Path getExecutable(java.nio.file.Path homeDir,
                                               java.lang.String executable)

Gets the given executable within the given java home directory.

Parameters:

homeDir - The home directory.

executable - The executable name.

Returns:

The executable path.

parse

@Nullable
public static @Nullable JavaInstall parse(java.nio.file.Path executable)

Execute the given Java executable, extracting information from it.

Parameters:

executable - The executable to run.

Returns:

The extracted JavaInstall information.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object