oracle.jdeveloper.library

Interface JDK

All Superinterfaces:

Displayable, JPaths, Library

All Known Implementing Classes:

AddinJDK, JDKAdapter, JDKNode

public interface JDK
extends Library

Encapsulates the notion of a JDK.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JDK_EXEC_PROPERTY The name of the property used to store the URL of the Java executable.
static java.lang.String	JDK_INSTALLED_VMS_PROPERTY The name of the property used to store the installed VM names of a JDK.
static java.lang.String	JDK_NAME_PROPERTY The name of the property used to store the name of a JDK.
static java.lang.String	JDK_SDK_BIN_DIR_PROPERTY The name of the property used to store the URL of the bin dir of a JDK.
static java.lang.String	JDK_VERSION_NUMBER_PROPERTY The name of the property used to store the version of a JDK.

Fields inherited from interface oracle.jdeveloper.library.Library

LIBRARY_ID_PROPERTY, LIBRARY_NAME_PROPERTY

Fields inherited from interface oracle.jdeveloper.library.JPaths

CLASSPATH_PROPERTY, DOCPATH_PROPERTY, ISLOCKED_PROPERTY, SOURCEPATH_PROPERTY

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getInstalledVMs() Get the installed VM names of this JDK.
java.net.URL	getJavaExecutable() Get the URL of the Java executable.
java.lang.String	getJavaExecutableNoConsole() Get the name of the non console Java executable if it exists.
VersionNumber	getJavaVersion() Get the Java version of this JDK expressed as a VersionNumber.
java.net.URL	getSDKBinDir() Get the URL of the bin directory of this JDK.
java.lang.String	getSDKBinJavaExecutableNoConsole() Get the name of the non console Java executable if it exists.
java.util.Properties	getSystemProperties() Get the Java system proprerties as they would be set when running in this JDK.
static VersionNumber	sanitizeVersionNumber(VersionNumber version) Given a JDK version, make sure the version starts with a number (the major version) and a dot.
void	setInstalledVMs(java.lang.String[] installedVMs) Set the installed VM names of this JDK.
void	setJavaExecutable(java.net.URL url) Set the URL of the Java executable.
void	setJavaVersion(VersionNumber ver) Set the Java version of this JDK.
void	setSDKBinDir(java.net.URL url) Set the URL of the bin directory of this JDK.

Methods inherited from interface oracle.jdeveloper.library.Library

equivalent, getDefaultClassPath, getDefaultDocPath, getDefaultSourcePath, getID, getName, initFromLibrary, setDefaultClassPath, setDefaultDocPath, setDefaultSourcePath, setName

Methods inherited from interface oracle.jdeveloper.library.JPaths

getClassPath, getDocPath, getSourcePath, isLocked, setClassPath, setDocPath, setLocked, setSourcePath

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel, getIcon, getLongLabel, getShortLabel, getToolTipText, toString

Field Detail

JDK_NAME_PROPERTY

static final java.lang.String JDK_NAME_PROPERTY

The name of the property used to store the name of a JDK.

See Also:

Constant Field Values

JDK_EXEC_PROPERTY

static final java.lang.String JDK_EXEC_PROPERTY

The name of the property used to store the URL of the Java executable.

See Also:

Constant Field Values

JDK_INSTALLED_VMS_PROPERTY

static final java.lang.String JDK_INSTALLED_VMS_PROPERTY

The name of the property used to store the installed VM names of a JDK.

See Also:

Constant Field Values

JDK_VERSION_NUMBER_PROPERTY

static final java.lang.String JDK_VERSION_NUMBER_PROPERTY

The name of the property used to store the version of a JDK.

See Also:

Constant Field Values

JDK_SDK_BIN_DIR_PROPERTY

static final java.lang.String JDK_SDK_BIN_DIR_PROPERTY

The name of the property used to store the URL of the bin dir of a JDK.

See Also:

Constant Field Values

Method Detail

getJavaExecutable

java.net.URL getJavaExecutable()

Get the URL of the Java executable.

Returns:

A URL which might be null if the Java executable could not be found

setJavaExecutable

void setJavaExecutable(java.net.URL url)

Set the URL of the Java executable.

Parameters:

url - A URL which should not be null

getInstalledVMs

java.lang.String[] getInstalledVMs()

Get the installed VM names of this JDK.

Returns:

The installed VM names which might be an empty array but will not be null

setInstalledVMs

void setInstalledVMs(java.lang.String[] installedVMs)

Set the installed VM names of this JDK.

Parameters:

installedVMs - The installed VM names which should not be null

sanitizeVersionNumber

static VersionNumber sanitizeVersionNumber(VersionNumber version)

Given a JDK version, make sure the version starts with a number (the major version) and a dot. If that is not the case, insert ".0" if the version starts with a number. For instance, 1.8 is fine, but 9+ea is turned into 9.0+ea. All this is done so Java versions can be sorted in VersionNumbers which only recognize dots as separators.

Parameters:

version - A JDK version

Returns:

A sanitized JDK version which might be the original one

getJavaVersion

VersionNumber getJavaVersion()

Get the Java version of this JDK expressed as a VersionNumber.

Returns:

A VersionNumber which might be null if the version could not be determined

setJavaVersion

void setJavaVersion(VersionNumber ver)

Set the Java version of this JDK.

Parameters:

ver - A version which should not be null

getSDKBinDir

java.net.URL getSDKBinDir()

Get the URL of the bin directory of this JDK.

Returns:

A URL which might be null if the bin directory could not be found

setSDKBinDir

void setSDKBinDir(java.net.URL url)

Set the URL of the bin directory of this JDK.

Parameters:

url - A URL which should not be null

getSDKBinJavaExecutableNoConsole

java.lang.String getSDKBinJavaExecutableNoConsole()

Get the name of the non console Java executable if it exists.

Returns:

The name of an executable which might be null

getJavaExecutableNoConsole

java.lang.String getJavaExecutableNoConsole()

Get the name of the non console Java executable if it exists.

Returns:

The name of an executable which might be null

getSystemProperties

java.util.Properties getSystemProperties()

Get the Java system proprerties as they would be set when running in this JDK. Note that system properties can be redefined through command line arguments (such as -D) or through API calls (such as System.setProperty(java.lang.String, java.lang.String)). The properties returned by this method may or may not match the actual properties during a future execution of the JVM. Callers should typically only use the standard Java properties relating to the JDK implementation itself, such as java.home or java.version, which will typically have the same values whenever this JDK is run.

Returns:

the system properties