Package org.opensolaris.os.dtrace

Class Probe

java.lang.Object

org.opensolaris.os.dtrace.Probe

All Implemented Interfaces:

java.io.Serializable

public final class Probe
extends java.lang.Object
implements java.io.Serializable

A ProbeDescription identifying a single probe combined with information about the identified probe.

Immutable. Supports persistence using XMLEncoder.

See Also:

Consumer.listProbes(ProbeDescription filter), Consumer.listProgramProbes(Program program), Serialized Form

Constructor Summary

Constructors

Constructor	Description
Probe(ProbeDescription probeDescription, ProbeInfo probeInfo)	Creates a Probe instance with the given identifying description and associated probe information.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)	Compares the specified object with this Probe instance for equality.
ProbeDescription	getDescription()	Gets the probe description identifying a single probe described by this instance.
ProbeInfo	getInfo()	Gets information including attributes and argument types of the probe identified by getDescription().
int	hashCode()	Overridden to ensure that equal instances have equal hash codes.
java.lang.String	toString()	Returns a string representation of this Probe useful for logging and not intended for display.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Probe

public Probe(ProbeDescription probeDescription,
             ProbeInfo probeInfo)

Creates a Probe instance with the given identifying description and associated probe information. Supports XML persistence.

Parameters:

probeDescription - probe description that identifies a single DTrace probe

probeInfo - information about the identified probe, null indicating that the information could not be obtained

Throws:

java.lang.NullPointerException - if the given probe description is null

Method Detail

getDescription

public ProbeDescription getDescription()

Gets the probe description identifying a single probe described by this instance.

Returns:

non-null probe description matching a single probe on the system

getInfo

public ProbeInfo getInfo()

Gets information including attributes and argument types of the probe identified by getDescription().

Returns:

information about the probe identified by getDescription(), or null if that information could not be obtained for any reason

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this Probe instance for equality. Defines equality as having the same probe description.

Overrides:

equals in class java.lang.Object

Returns:

true if and only if the specified object is also a Probe and both instances return equal values from getDescription().

hashCode

public int hashCode()

Overridden to ensure that equal instances have equal hash codes.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of this Probe useful for logging and not intended for display. The exact details of the representation are unspecified and subject to change, but the following format may be regarded as typical:

 class-name[property1 = value1, property2 = value2]
 

Overrides:

toString in class java.lang.Object