| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/ProbeDescription.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ProbeDescription</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProbeDescription";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProbeDescription.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.Spec.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/ProbeDescription.html" target="_top">Frames</a></li>
<li><a href="ProbeDescription.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.opensolaris.os.dtrace</div>
<h2 title="Class ProbeDescription" class="title">Class ProbeDescription</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.ProbeDescription</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ProbeDescription</span>
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>></pre>
<div class="block">A DTrace probe description consists of provider, module, function,
and name. A single probe description may identify a single DTrace
probe or match multiple probes. Any field may be wildcarded by
omission (set to null) or set to a glob-style pattern:
<pre>
* Matches any string, including the null string
? Matches any single character
[ ... ] Matches any one of the enclosed characters. A pair of
characters separated by - matches any character
between the pair, inclusive. If the first
character after the [ is !, any character not
enclosed in the set is matched.
\ Interpret the next character as itself, without any
special meaning
</pre>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#listProbes-org.opensolaris.os.dtrace.ProbeDescription-"><code>Consumer.listProbes(ProbeDescription filter)</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.ProbeDescription">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.Spec.html" title="enum in org.opensolaris.os.dtrace">ProbeDescription.Spec</a></span></code>
<div class="block">Enumerates the provider, module, function, and name fields of a
probe description.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#EMPTY">EMPTY</a></span></code>
<div class="block">Instance with empty provider, module, function, and name fields
matches all DTrace probes on a system.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-int-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">ProbeDescription</a></span>(int probeID,
java.lang.String probeProvider,
java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</code>
<div class="block">Supports XML persistence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-">ProbeDescription</a></span>(java.lang.String probeName)</code>
<div class="block">Creates a fully qualified probe description from the name given
in the format <i><code>provider:module:function:name</code></i> or
else a probe description that specifies only the unqualified
probe name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-">ProbeDescription</a></span>(java.lang.String probeFunction,
java.lang.String probeName)</code>
<div class="block">Creates a probe description that specifies the probe name
qualified only by the function name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-java.lang.String-">ProbeDescription</a></span>(java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</code>
<div class="block">Creates a probe description that specifies the probe name
qualified by the function name and module name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">ProbeDescription</a></span>(java.lang.String probeProvider,
java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</code>
<div class="block">Creates a fully qualified probe description.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#compareTo-org.opensolaris.os.dtrace.ProbeDescription-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> p)</code>
<div class="block">Defines the natural ordering of probe descriptions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this probe description for
equality.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getFunction--">getFunction</a></span>()</code>
<div class="block">Gets the function name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getID--">getID</a></span>()</code>
<div class="block">Gets the probe ID.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getModule--">getModule</a></span>()</code>
<div class="block">Gets the module name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getName--">getName</a></span>()</code>
<div class="block">Gets the unqualified probe name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#getProvider--">getProvider</a></span>()</code>
<div class="block">Gets the provider name.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal probe descriptions have equal
hashcodes.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns <code>true</code> if provider, module, function, and name are
all omitted.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#parse-java.lang.String-">parse</a></span>(java.lang.String s)</code>
<div class="block">Generates a probe description from a string in the same format
returned by <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#toString--"><code>toString()</code></a>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#toString--">toString</a></span>()</code>
<div class="block">Gets the string representation of this probe description.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="EMPTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY</h4>
<pre>public static final <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> EMPTY</pre>
<div class="block">Instance with empty provider, module, function, and name fields
matches all DTrace probes on a system.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProbeDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProbeDescription</h4>
<pre>public ProbeDescription(java.lang.String probeName)</pre>
<div class="block">Creates a fully qualified probe description from the name given
in the format <i><code>provider:module:function:name</code></i> or
else a probe description that specifies only the unqualified
probe name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>probeName</code> - either the fully qualified name in the format
<i><code>provider:module:function:name</code></i> or else (if no colon
is present) the unqualified name interpreted as <code>:::probeName</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>ProbeDescription(String probeProvider,
String probeModule, String probeFunction, String probeName)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#parse-java.lang.String-"><code>parse(String s)</code></a></dd>
</dl>
</li>
</ul>
<a name="ProbeDescription-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProbeDescription</h4>
<pre>public ProbeDescription(java.lang.String probeFunction,
java.lang.String probeName)</pre>
<div class="block">Creates a probe description that specifies the probe name
qualified only by the function name.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>ProbeDescription(String probeProvider,
String probeModule, String probeFunction, String probeName)</code></a></dd>
</dl>
</li>
</ul>
<a name="ProbeDescription-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProbeDescription</h4>
<pre>public ProbeDescription(java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</pre>
<div class="block">Creates a probe description that specifies the probe name
qualified by the function name and module name.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#ProbeDescription-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>ProbeDescription(String probeProvider,
String probeModule, String probeFunction, String probeName)</code></a></dd>
</dl>
</li>
</ul>
<a name="ProbeDescription-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProbeDescription</h4>
<pre>public ProbeDescription(java.lang.String probeProvider,
java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</pre>
<div class="block">Creates a fully qualified probe description. If no pattern
syntax is used and no field is omitted, the resulting description
matches at most one DTrace probe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>probeProvider</code> - provider name, may be null or empty to match
all providers or use pattern syntax to match multiple providers</dd>
<dd><code>probeModule</code> - module name, may be null or empty to match all
modules or use pattern syntax to match multiple modules</dd>
<dd><code>probeFunction</code> - function name, may be null or empty to match
all functions or use pattern syntax to match multiple functions</dd>
<dd><code>probeName</code> - unqualified probe name, may be null or empty to
match all names or use pattern syntax to match multiple names</dd>
</dl>
</li>
</ul>
<a name="ProbeDescription-int-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProbeDescription</h4>
<pre>public ProbeDescription(int probeID,
java.lang.String probeProvider,
java.lang.String probeModule,
java.lang.String probeFunction,
java.lang.String probeName)</pre>
<div class="block">Supports XML persistence.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="parse-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>public static <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> parse(java.lang.String s)
throws java.text.ParseException</pre>
<div class="block">Generates a probe description from a string in the same format
returned by <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#toString--"><code>toString()</code></a>. Parses the string from right to
left.
<pre><code>
<i>provider:module:function:name</i>
</code></pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null probe description</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.text.ParseException</code> - if <code>s</code> does not have the expected
format. The error offset is the index of the first unexpected
character encountered starting from the last character and
reading backwards.</dd>
<dd><code>java.lang.NullPointerException</code> - if the given string is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre>public int getID()</pre>
<div class="block">Gets the probe ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID generated from a sequence by the native DTrace
library, identifies the probe among all probes on the system</dd>
</dl>
</li>
</ul>
<a name="getProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProvider</h4>
<pre>public java.lang.String getProvider()</pre>
<div class="block">Gets the provider name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null provider name, may be an empty string to
indicate omission</dd>
</dl>
</li>
</ul>
<a name="getModule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModule</h4>
<pre>public java.lang.String getModule()</pre>
<div class="block">Gets the module name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null module name, may be an empty string to indicate
omission</dd>
</dl>
</li>
</ul>
<a name="getFunction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunction</h4>
<pre>public java.lang.String getFunction()</pre>
<div class="block">Gets the function name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null function name, may be an empty string to
indicate omission</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block">Gets the unqualified probe name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null probe name, may be an empty string to indicate
omission</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public boolean isEmpty()</pre>
<div class="block">Returns <code>true</code> if provider, module, function, and name are
all omitted. An empty probe description matches all DTrace
probes on a system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if all probe fields are omitted, <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Compares the specified object with this probe description for
equality. Defines equality as having the same fields. Omitted
fields must be omitted in both instances in order for them to be
equal, but it makes no difference whether <code>null</code> or empty
string was used to indicate omission.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if and only if all corresponding fields of
both probe descriptions are either both omitted (null or empty)
or else equal as defined by <code>String.equals()</code></dd>
</dl>
</li>
</ul>
<a name="compareTo-org.opensolaris.os.dtrace.ProbeDescription-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a> p)</pre>
<div class="block">Defines the natural ordering of probe descriptions. Returns the
natural ordering of the first unequal pair of corresponding
fields (starting with the provider and continuing to the
unqualified name only if all other fields are equal).
Corresponding fields are equal if they are both omitted or both
equal as defined by <code>String.equals()</code>. It makes no difference if <code>null</code> or
empty string is used to indicate omission. The behavior is
consistent with the <a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html#equals-java.lang.Object-"><code>equals()</code></a> method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.html" title="class in org.opensolaris.os.dtrace">ProbeDescription</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>-1, 0, or 1 as this probe description is less than, equal
to, or greater than the given probe description</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Overridden to ensure that equal probe descriptions have equal
hashcodes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Gets the string representation of this probe description. The
format is as follows:
<pre><code>
<i>provider:module:function:name</i>
</code></pre>
Individual fields may be empty, but none of the three delimiting
colons is ever omitted. If this instance uses pattern matching
syntax to match multiple probes, that syntax is preserved in the
string representation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProbeDescription.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeData.KeyField.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProbeDescription.Spec.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/ProbeDescription.html" target="_top">Frames</a></li>
<li><a href="ProbeDescription.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>