This class is not part of the public API.

Class: com.sun.management.VMOption

  • public class VMOption
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,

Authors:
@author Mandy Chung
See:
@see Java Virtual Machine
Since:
@since 1.6

Inheritance

Superclass tree:

Methods

  • VMOptiontop

    public VMOption(String name, String value, boolean writeable, VMOption.Origin origin)
    Constructs a VMOption.
    Parameters:
    @param name Name of a VM option.
    @param value Value of a VM option.
    @param writeable true if a VM option can be set dynamically, or false otherwise.
    @param origin where the value of a VM option came from.
    Exceptions:
    @throws NullPointerException if the name or value is null
    Related Links:
    Google Code Search
    Stack Overflow

  • VMOptiontop

    private VMOption(CompositeData cd)
    Constructs a VMOption object from a CompositeData.
    Related Links:
    Google Code Search
    Stack Overflow

  • fromtop

    public static VMOption from(CompositeData cd)
    Returns a VMOption object represented by the given CompositeData. The given CompositeData must contain the following attributes:

    Attribute NameType
    namejava.lang.String
    valuejava.lang.String
    originjava.lang.String
    writeablejava.lang.Boolean
    Parameters:
    @param cd CompositeData representing a VMOption
    Return:
    @return a VMOption object represented by cd if cd is not null; null otherwise.
    Exceptions:
    @throws IllegalArgumentException if cd does not represent a VMOption with the attributes described above.
    Related Links:
    Google Code Search
    Stack Overflow

  • getNametop

    public String getName()
    Returns the name of this VM option.
    Return:
    @return the name of this VM option.
    Related Links:
    Google Code Search
    Stack Overflow

  • getOrigintop

    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.
    Return:
    @return where the value of this VM option came from.
    Related Links:
    Google Code Search
    Stack Overflow

  • getValuetop

    public String getValue()
    Returns the value of this VM option at the time when this VMOption was created. The value could have been changed.
    Return:
    @return the value of the VM option at the time when this VMOption was created.
    Related Links:
    Google Code Search
    Stack Overflow

  • isWriteabletop

    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.
    Return:
    @return true if this VM option is writeable; false otherwise.
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

     getClass().getName() + '@' + Integer.toHexString(hashCode())
    Return:
    @return a string representation of the object.
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

Fields