Information about a VM option including its value and where the value came from which is referred as its origin.

Each VM option has a default value. A VM option can be set at VM creation time typically as a command line argument to the launcher or an argument passed to the VM created using the JNI invocation interface. In addition, a VM option may be set via an environment variable or a configuration file. A VM option can also be set dynamically via a management interface after the VM was started. A VMOption contains the value of a VM option and the origin of that value at the time this VMOption object was constructed. The value of the VM option may be changed after the VMOption object was constructed,

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	VMOption.Origin Origin of the value of a VM option.

Modifier and Type	Field and Description
private String	name
private VMOption.Origin	origin
private String	value
private boolean	writeable

Constructor Summary

Access	Constructor and Description
public	VMOption(String Name of a VM option. name, String Value of a VM option. value, boolean `true` if a VM option can be set dynamically, or `false` otherwise. writeable, VMOption.Origin where the value of a VM option came from. origin) Constructs a `VMOption`.
private	VMOption(CompositeData cd) Constructs a `VMOption` object from a `CompositeData`.

Method Summary

Modifier and Type	Method and Description
public static VMOption	Returns: a `VMOption` object represented by `cd` if `cd` is not `null`; `null` otherwise. from(CompositeData `CompositeData` representing a `VMOption` cd) Returns a `VMOption` object represented by the given `CompositeData`.
public String	Returns: the name of this VM option. getName() Returns the name of this VM option.
public VMOption.Origin	Returns: where the value of this VM option came from. getOrigin() Returns the origin of the value of this VM option.
public String	Returns: the value of the VM option at the time when this `VMOption` was created. getValue() Returns the value of this VM option at the time when this `VMOption` was created.
public boolean	Returns: `true` if this VM option is writeable; `false` otherwise. isWriteable() Tests if this VM option is writeable.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

name	back to summary
private String name

origin	back to summary
private VMOption.Origin origin

value	back to summary
private String value

writeable	back to summary
private boolean writeable

Constructor Detail

VMOption back to summary

VMOption	back to summary
public VMOption(String name, String value, boolean writeable, VMOption.Origin origin) Constructs a `VMOption`. Parameters name:String Name of a VM option. value:String Value of a VM option. writeable:boolean `true` if a VM option can be set dynamically, or `false` otherwise. origin:VMOption.Origin where the value of a VM option came from. Exceptions NullPointerException: if the name or value is `null`

public VMOption(String name, String value, boolean writeable, VMOption.Origin origin)

Constructs a VMOption.

Parameters

name:String: Name of a VM option.
value:String: Value of a VM option.
writeable:boolean: true if a VM option can be set dynamically, or false otherwise.
origin:VMOption.Origin: where the value of a VM option came from.

Exceptions

NullPointerException:: if the name or value is null

VMOption	back to summary
private VMOption(CompositeData cd) Constructs a `VMOption` object from a `CompositeData`.

Method Detail

from back to summary

public static VMOption from(CompositeData cd)

Returns a VMOption object represented by the given CompositeData. The given CompositeData must contain the following attributes:

description

Attribute Name Type

name java.lang.String

value java.lang.String

origin java.lang.String

writeable java.lang.Boolean

Parameters

cd:CompositeData: CompositeData representing a VMOption

Returns:VMOption

a VMOption object represented by cd if cd is not null; null otherwise.

Exceptions

IllegalArgumentException:: if cd does not represent a VMOption with the attributes described above.

getName	back to summary
public String getName() Returns the name of this VM option. Returns:String the name of this VM option.

getName

back to summary

public String getName()

Returns the name of this VM option.

Returns:String: the name of this VM option.

getOrigin	back to summary
public VMOption.Origin getOrigin() Returns the origin of the value of this VM option. That is, where the value of this VM option came from. Returns:VMOption.Origin where the value of this VM option came from.

getOrigin

back to summary

public VMOption.Origin getOrigin()

Returns the origin of the value of this VM option. That is, where the value of this VM option came from.

Returns:VMOption.Origin: where the value of this VM option came from.

getValue back to summary

getValue	back to summary
public String getValue() Returns the value of this VM option at the time when this `VMOption` was created. The value could have been changed. Returns:String the value of the VM option at the time when this `VMOption` was created.

public String getValue()

Returns the value of this VM option at the time when this VMOption was created. The value could have been changed.

Returns:String: the value of the VM option at the time when this VMOption was created.

isWriteable back to summary

isWriteable	back to summary
public boolean isWriteable() Tests if this VM option is writeable. If this VM option is writeable, it can be set by the `HotSpotDiagnosticMXBean.setVMOption` method. Returns:boolean `true` if this VM option is writeable; `false` otherwise.

public boolean isWriteable()

Tests if this VM option is writeable. If this VM option is writeable, it can be set by the HotSpotDiagnosticMXBean.setVMOption method.

Returns:boolean: true if this VM option is writeable; false otherwise.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

com.sun.management back to summary

public final Enum VMOption.Origin

Class Inheritance

extends Enum<VMOption.Origin>

java.lang.Object
java.lang.Enum
com.sun.management.VMOption.Origin

Origin of the value of a VM option. It tells where the value of a VM option came from.

Since: 1.6

Field Summary

Modifier and Type	Field and Description
public static final VMOption.Origin	ATTACH_ON_DEMAND The VM option was set using the attach framework.
public static final VMOption.Origin	CONFIG_FILE The VM option was set via a configuration file.
public static final VMOption.Origin	DEFAULT The VM option has not been set and its value is the default value.
public static final VMOption.Origin	ENVIRON_VAR The VM option was set via an environment variable.
public static final VMOption.Origin	ERGONOMIC The VM option was set via the VM ergonomic support.
public static final VMOption.Origin	MANAGEMENT The VM option was set via the management interface after the VM was started.
public static final VMOption.Origin	OTHER The VM option was set via some other mechanism.
public static final VMOption.Origin	VM_CREATION The VM option was set at VM creation time typically as a command line argument to the launcher or an argument passed to the VM created using the JNI invocation interface.

Constructor Summary

Access	Constructor and Description
private	Origin()

Method Summary

Modifier and Type	Method and Description
public static VMOption.Origin	valueOf(String name)
public static VMOption.Origin[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ATTACH_ON_DEMAND	back to summary
public static final VMOption.Origin ATTACH_ON_DEMAND The VM option was set using the attach framework. Since 9

ATTACH_ON_DEMAND

back to summary

public static final VMOption.Origin ATTACH_ON_DEMAND

The VM option was set using the attach framework.

Since: 9

CONFIG_FILE	back to summary
public static final VMOption.Origin CONFIG_FILE The VM option was set via a configuration file.

DEFAULT	back to summary
public static final VMOption.Origin DEFAULT The VM option has not been set and its value is the default value.

ENVIRON_VAR	back to summary
public static final VMOption.Origin ENVIRON_VAR The VM option was set via an environment variable.

ERGONOMIC	back to summary
public static final VMOption.Origin ERGONOMIC The VM option was set via the VM ergonomic support.

MANAGEMENT	back to summary
public static final VMOption.Origin MANAGEMENT The VM option was set via the management interface after the VM was started.

OTHER	back to summary
public static final VMOption.Origin OTHER The VM option was set via some other mechanism.

VM_CREATION	back to summary
public static final VMOption.Origin VM_CREATION The VM option was set at VM creation time typically as a command line argument to the launcher or an argument passed to the VM created using the JNI invocation interface.

Constructor Detail

Origin	back to summary
private Origin()

Method Detail

valueOf	back to summary
public static VMOption.Origin valueOf(String name)

values	back to summary
public static VMOption.Origin[] values()

public Class VMOption

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum VMOption.Origin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail