org.opensolaris.os.dtrace
Class ProbeInfo

java.lang.Object
  extended by org.opensolaris.os.dtrace.ProbeInfo
All Implemented Interfaces:
java.io.Serializable

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

Probe stability information. Does not identify a probe, but gives information about a single probe identified by a ProbeDescription. A ProbeDescription can match multiple probes using pattern syntax (globbing) and wildcarding (field omission), but it does not normally make sense to associate a ProbeInfo with a ProbeDescription unless that description matches exactly one probe on the system. A Probe pairs a ProbeDescription with information about the DTrace probe it identifies.

Immutable. Supports persistence using XMLEncoder.

See Also:
Consumer.listProbeDetail(ProbeDescription filter), Consumer.listProgramProbeDetail(Program program), Serialized Form

Constructor Summary
ProbeInfo(InterfaceAttributes singleProbeAttributes, InterfaceAttributes argAttributes)
          Creates a ProbeInfo instance from the given attributes.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares the specified object with this ProbeInfo instance for equality.
 InterfaceAttributes getArgumentAttributes()
          Gets the interface attributes of the arguments to a probe.
 InterfaceAttributes getProbeAttributes()
          Gets the interface attributes of a probe.
 int hashCode()
          Overridden to ensure that equal instances have equal hash codes.
 java.lang.String toString()
          Gets a string representation of this ProbeInfo 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

ProbeInfo

public ProbeInfo(InterfaceAttributes singleProbeAttributes,
                 InterfaceAttributes argAttributes)
Creates a ProbeInfo instance from the given attributes. Supports XML persistence.

Throws:
java.lang.NullPointerException - if any parameter is null
Method Detail

getProbeAttributes

public InterfaceAttributes getProbeAttributes()
Gets the interface attributes of a probe.

Returns:
non-null attributes including stability levels and dependency class

getArgumentAttributes

public InterfaceAttributes getArgumentAttributes()
Gets the interface attributes of the arguments to a probe.

Returns:
non-null attributes including stability levels and dependency class of the arguments to a probe

equals

public boolean equals(java.lang.Object o)
Compares the specified object with this ProbeInfo instance for equality. Defines equality as having equal probe attributes and equal argument attributes.

Overrides:
equals in class java.lang.Object
Returns:
true if and only if the specified object is also a ProbeInfo and both instances have the same attributes

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()
Gets a string representation of this ProbeInfo 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