OpenJDK 24 · sun.jvmstat.monitor.MonitoredVm · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addVmListener(VmListener the VmListener to add. listener) Add a VmListener.
public void	clearLastException() Clear the last exception.
public void	detach() Detach from target Java Virtual Machine.
public Monitor	Returns: Monitor - the `Monitor` object that can be used to monitor the named instrumentation object, or `null` if the named object doesn't exist. findByName(String the name of the Instrumentation object to find. name) Find a named Instrumentation object.
public List<Monitor>	Returns: `List<Monitor>` - a List of `Monitor` objects that can be used to monitor the instrumentation objects whose names match the given pattern. If no instrumentation objects have names matching the given pattern, then an empty List is returned. findByPattern(String a string containing a pattern as described in `java.util.regex.Pattern`. patternString) Find all Instrumentation objects with names matching the given pattern.
public int	Returns: int - the current polling interval in milliseconds. getInterval() Get the polling interval.
public Exception	Returns: Exception - the last exception that occurred during polling or `null` if no error condition exists. getLastException() Get the last exception encountered while polling this MonitoredVm.
public VmIdentifier	Returns: VmIdentifier - the fully resolved Vm identifier associated with this MonitoredVm. getVmIdentifier() Get the VmIdentifier associated with this MonitoredVm
public boolean	Returns: boolean - true if the instance has a non-null error condition set, false otherwise. isErrored() Test if this MonitoredVm is in the errored state.
public void	removeVmListener(VmListener the VmListener to be removed. listener) Remove a VmListener.
public void	setInterval(int the polling interval in milliseconds interval) Set the polling interval to `interval` milliseconds.
public void	setLastException(Exception the exception to record. cause) Set the last exception encountered while polling this MonitoredVm.

Method Detail

addVmListener	back to summary
public void addVmListener(VmListener listener) throws MonitorException Add a VmListener. The given listener is added to the list of VmListener objects to be notified of MonitoredVm related events. Parameters listener:VmListener the VmListener to add. Exceptions MonitorException: Thrown if any problems occur while attempting to add this listener.

addVmListener

back to summary

public void addVmListener(VmListener listener) throws MonitorException

Add a VmListener. The given listener is added to the list of VmListener objects to be notified of MonitoredVm related events.

Parameters

listener:VmListener: the VmListener to add.

Exceptions

MonitorException:: Thrown if any problems occur while attempting to add this listener.

clearLastException	back to summary
public void clearLastException() Clear the last exception. Calling this method will clear the errored state of this MonitoredVm. However, there is no guarantee that clearing the the errored state return the asynchronous polling task to an operational state.

detach	back to summary
public void detach() Detach from target Java Virtual Machine. After calling this method, updates of the instrumentation data values may be halted. All event notifications are halted. Further interactions with this object should be avoided.

findByName back to summary

findByName	back to summary
public Monitor findByName(String name) throws MonitorException Find a named Instrumentation object. This method will look for the named instrumentation object in the instrumentation exported by this Java Virtual Machine. If an instrumentation object with the given name exists, a Monitor interface to that object will be return. Otherwise, the method returns `null`. Parameters name:String the name of the Instrumentation object to find. Returns:Monitor Monitor - the `Monitor` object that can be used to monitor the named instrumentation object, or `null` if the named object doesn't exist. Exceptions MonitorException: Thrown if an error occurs while communicating with the target Java Virtual Machine.

public Monitor findByName(String name) throws MonitorException

Find a named Instrumentation object. This method will look for the named instrumentation object in the instrumentation exported by this Java Virtual Machine. If an instrumentation object with the given name exists, a Monitor interface to that object will be return. Otherwise, the method returns null.

Parameters

name:String: the name of the Instrumentation object to find.

Returns:Monitor

Monitor - the Monitor object that can be used to monitor the named instrumentation object, or null if the named object doesn't exist.

Exceptions

MonitorException:: Thrown if an error occurs while communicating with the target Java Virtual Machine.

findByPattern back to summary

findByPattern	back to summary
public List<Monitor> findByPattern(String patternString) throws MonitorException Find all Instrumentation objects with names matching the given pattern. This method returns a `List` of Monitor objects such that the name of each object matches the given pattern. Parameters patternString:String a string containing a pattern as described in `java.util.regex.Pattern`. Returns:List<Monitor> `List<Monitor>` - a List of `Monitor` objects that can be used to monitor the instrumentation objects whose names match the given pattern. If no instrumentation objects have names matching the given pattern, then an empty List is returned. Exceptions MonitorException: Thrown if an error occurs while communicating with the target Java Virtual Machine. See Also `java.util.regex.Pattern`

public List<Monitor> findByPattern(String patternString) throws MonitorException

Find all Instrumentation objects with names matching the given pattern. This method returns a List of Monitor objects such that the name of each object matches the given pattern.

Parameters

patternString:String: a string containing a pattern as described in java.util.regex.Pattern.

Returns:List<Monitor>

List<Monitor> - a List of Monitor objects that can be used to monitor the instrumentation objects whose names match the given pattern. If no instrumentation objects have names matching the given pattern, then an empty List is returned.

Exceptions

MonitorException:: Thrown if an error occurs while communicating with the target Java Virtual Machine.

See Also

java.util.regex.Pattern

getInterval back to summary

getInterval	back to summary
public int getInterval() Get the polling interval. Returns:int int - the current polling interval in milliseconds. See Also `setInterval`

public int getInterval()

Get the polling interval.

Returns:int: int - the current polling interval in milliseconds.
See Also: setInterval

getLastException back to summary

getLastException	back to summary
public Exception getLastException() Get the last exception encountered while polling this MonitoredVm. Returns the last exception observed by the implementation dependent polling task or `null` if no such error has occurred. Returns:Exception Exception - the last exception that occurred during polling or `null` if no error condition exists. See Also `isErrored`, `setLastException`

public Exception getLastException()

Get the last exception encountered while polling this MonitoredVm. Returns the last exception observed by the implementation dependent polling task or null if no such error has occurred.

Returns:Exception: Exception - the last exception that occurred during polling or null if no error condition exists.
See Also: isErrored, setLastException

getVmIdentifier	back to summary
public VmIdentifier getVmIdentifier() Get the VmIdentifier associated with this MonitoredVm Returns:VmIdentifier VmIdentifier - the fully resolved Vm identifier associated with this MonitoredVm.

getVmIdentifier

back to summary

public VmIdentifier getVmIdentifier()

Get the VmIdentifier associated with this MonitoredVm

Returns:VmIdentifier: VmIdentifier - the fully resolved Vm identifier associated with this MonitoredVm.

isErrored back to summary

isErrored	back to summary
public boolean isErrored() Test if this MonitoredVm is in the errored state. The errored state exists only if an error was reported with call to `setLastException` and only if the parameter to that call was non-null and no subsequent calls are made to `clearLastException`. Returns:boolean boolean - true if the instance has a non-null error condition set, false otherwise. See Also `setLastException`, `getLastException`

public boolean isErrored()

Test if this MonitoredVm is in the errored state. The errored state exists only if an error was reported with call to setLastException and only if the parameter to that call was non-null and no subsequent calls are made to clearLastException.

Returns:boolean: boolean - true if the instance has a non-null error condition set, false otherwise.
See Also: setLastException, getLastException

removeVmListener	back to summary
public void removeVmListener(VmListener listener) throws MonitorException Remove a VmListener. The given listener is removed from the list of VmListener objects to be notified of MonitoredVm related events. Parameters listener:VmListener the VmListener to be removed. Exceptions MonitorException: Thrown if any problems occur while attempting to remove this listener.

removeVmListener

back to summary

public void removeVmListener(VmListener listener) throws MonitorException

Remove a VmListener. The given listener is removed from the list of VmListener objects to be notified of MonitoredVm related events.

Parameters

listener:VmListener: the VmListener to be removed.

Exceptions

MonitorException:: Thrown if any problems occur while attempting to remove this listener.

setInterval back to summary

setInterval	back to summary
public void setInterval(int interval) Set the polling interval to `interval` milliseconds. Polling based monitoring implementations need to refresh the instrumentation data on a periodic basis. This interface allows the interval to override the implementation specific default interval. Parameters interval:int the polling interval in milliseconds

public void setInterval(int interval)

Set the polling interval to interval milliseconds. Polling based monitoring implementations need to refresh the instrumentation data on a periodic basis. This interface allows the interval to override the implementation specific default interval.

Parameters

interval:int: the polling interval in milliseconds

setLastException back to summary

setLastException	back to summary
public void setLastException(Exception cause) Set the last exception encountered while polling this MonitoredVm. Polling implementations may choose to poll asynchronously. This method allows an asynchronous task to communicate any polling related exceptions with the application. When a non-null exception is reported through this interface, the MonitoredVm instance is considered to be in the errored state. Parameters cause:Exception the exception to record. See Also `isErrored`

public void setLastException(Exception cause)

Set the last exception encountered while polling this MonitoredVm. Polling implementations may choose to poll asynchronously. This method allows an asynchronous task to communicate any polling related exceptions with the application. When a non-null exception is reported through this interface, the MonitoredVm instance is considered to be in the errored state.

Parameters

cause:Exception: the exception to record.

See Also

isErrored

public Interface MonitoredVm

Method Summary

Method Detail