| java.lang.Object
 com.sun.tools.attach.VirtualMachineDescriptor
| VirtualMachineDescriptor | | public class VirtualMachineDescriptor (Code) | | Describes a Java virtual machine.
A VirtualMachineDescriptor is a container class used to
describe a Java virtual machine. It encapsulates an identifier that identifies
a target virtual machine, and a reference to the
com.sun.tools.attach.spi.AttachProvider AttachProvider that should be used
when attempting to attach to the virtual machine. The identifier is
implementation-dependent but is typically the process identifier (or pid)
environments where each Java virtual machine runs in its own operating system
process.
A VirtualMachineDescriptor also has a
VirtualMachineDescriptor.displayName() displayName .
The display name is typically a human readable string that a tool might
display to a user. For example, a tool that shows a list of Java
virtual machines running on a system might use the display name rather
than the identifier. A VirtualMachineDescriptor may be
created without a display name. In that case the identifier is
used as the display name.
VirtualMachineDescriptor instances are typically created by
invoking the
com.sun.tools.attach.VirtualMachine.list VirtualMachine.list() method. This returns the complete list of descriptors to describe the
Java virtual machines known to all installed
com.sun.tools.attach.spi.AttachProvider attach providers .
since:
1.6 |
| Method Summary | |
| public String | displayName()
Return the display name component of this descriptor. | | public boolean | equals(Object ob)
Tests this VirtualMachineDescriptor for equality with another object.
If the given object is not a VirtualMachineDescriptor then this
method returns false. | | public int | hashCode()
Returns a hash-code value for this VirtualMachineDescriptor. | | public String | id()
Return the identifier component of this descriptor. | | public AttachProvider | provider()
Return the AttachProvider that this descriptor references. | | public String | toString()
Returns the string representation of the VirtualMachineDescriptor. |
| VirtualMachineDescriptor | | public VirtualMachineDescriptor(AttachProvider provider, String id, String displayName)(Code) | | Creates a virtual machine descriptor from the given components.
Parameters:
provider - The AttachProvider to attach to the Java virtual machine.
Parameters:
id - The virtual machine identifier.
Parameters:
displayName - The display name.
throws:
NullPointerException - If any of the arguments are null |
| VirtualMachineDescriptor | | public VirtualMachineDescriptor(AttachProvider provider, String id)(Code) | | Creates a virtual machine descriptor from the given components.
This convenience constructor works as if by invoking the
three-argument constructor as follows:
new
VirtualMachineDescriptor.VirtualMachineDescriptor(AttachProvider,String,String)VirtualMachineDescriptor (provider, id, id);
That is, it creates a virtual machine descriptor such that
the display name is the same as the virtual machine
identifier.
Parameters:
provider - The AttachProvider to attach to the Java virtual machine.
Parameters:
id - The virtual machine identifier.
throws:
NullPointerException - If provider or id is null. |
| displayName | | public String displayName()(Code) | | Return the display name component of this descriptor.
The display name component of this descriptor. |
| equals | | public boolean equals(Object ob)(Code) | | Tests this VirtualMachineDescriptor for equality with another object.
If the given object is not a VirtualMachineDescriptor then this
method returns false. For two VirtualMachineDescriptors to
be considered equal requires that they both reference the same
provider, and their
VirtualMachineDescriptor.id() identifiers are equal.
This method satisfies the general contract of the
java.lang.Object.equals(Object) Object.equals method.
Parameters:
ob - The object to which this object is to be compared true if, and only if, the given object isa VirtualMachineDescriptor that is equal to thisVirtualMachineDescriptor. |
| hashCode | | public int hashCode()(Code) | | Returns a hash-code value for this VirtualMachineDescriptor. The hash
code is based upon the descriptor's components, and satifies
the general contract of the
java.lang.Object.hashCode Object.hashCode method.
A hash-code value for this descriptor. |
| id | | public String id()(Code) | | Return the identifier component of this descriptor.
The identifier component of this descriptor. |
| provider | | public AttachProvider provider()(Code) | | Return the AttachProvider that this descriptor references.
The AttachProvider that this descriptor references. |
| toString | | public String toString()(Code) | | Returns the string representation of the VirtualMachineDescriptor.
|
|
|