| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/Option.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>Option</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="Option";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":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/Option.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/MinValue.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html" title="class 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/Option.html" target="_top">Frames</a></li>
<li><a href="Option.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>Nested | </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 Option" class="title">Class Option</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.Option</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Option</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A DTrace option and its value. Compile-time options must be set
before calling <code>Consumer</code> <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.lang.String-java.lang.String...-"><code>compile(String program, ...)</code></a> or <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.io.File-java.lang.String...-"><code>compile(File
program, ...)</code></a> in order to affect program compilation. Runtime
options may be set anytime before calling <code>Consumer</code> <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#go--"><code>go()</code></a>, and some of them may be changed while a consumer
is running.
<p>
See the <a
href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlis?a=view>
<b>Options and Tunables</b></a> chapter of the <i>Solaris Dynamic
Tracing Guide</i>.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.Option">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggrate">aggrate</a></span></code>
<div class="block">Rate of aggregation reading (time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsize">aggsize</a></span></code>
<div class="block">Aggregation buffer size (size).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey">aggsortkey</a></span></code>
<div class="block">Denotes that aggregation data should be sorted in tuple order,
with ties broken by value order (no option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos">aggsortkeypos</a></span></code>
<div class="block">When multiple aggregation tuple elements are present, the
position of the tuple element that should act as the primary sort
key (zero-based index).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos">aggsortpos</a></span></code>
<div class="block">When multiple aggregations are being printed, the position of the
aggregation that should act as the primary sort key (zero-based
index).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev">aggsortrev</a></span></code>
<div class="block">Denotes that aggregation data should be sorted in descending
order (no option value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#amin">amin</a></span></code>
<div class="block">Set program attribute minimum (compile-time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#argref">argref</a></span></code>
<div class="block">Do not require all macro args to be used (compile-time; no option
value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy">bufpolicy</a></span></code>
<div class="block">Buffering policy (<a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SWITCH"><code>switch</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_FILL"><code>fill</code></a>, or <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_RING"><code>ring</code></a>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#BUFPOLICY_FILL">BUFPOLICY_FILL</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_FILL"><code>fill</code></a>
buffer policy is set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#BUFPOLICY_RING">BUFPOLICY_RING</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_RING"><code>ring</code></a>
buffer policy is set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#BUFPOLICY_SWITCH">BUFPOLICY_SWITCH</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the default <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SWITCH"><code>switch</code></a> buffer policy is set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize">bufresize</a></span></code>
<div class="block">Buffer resizing policy (<a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_AUTO"><code>auto</code></a> or <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_MANUAL"><code>manual</code></a>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#BUFRESIZE_AUTO">BUFRESIZE_AUTO</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> option when the default <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_AUTO"><code>auto</code></a> buffer resize policy is set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#BUFRESIZE_MANUAL">BUFRESIZE_MANUAL</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_MANUAL"><code>manual</code></a> buffer resize policy is set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufsize">bufsize</a></span></code>
<div class="block">Principal buffer size (size).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#cleanrate">cleanrate</a></span></code>
<div class="block">Cleaning rate (time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#cpp">cpp</a></span></code>
<div class="block">Run cpp(1) preprocessor on D script files (compile-time; no
option value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#cpppath">cpppath</a></span></code>
<div class="block">Used together with <a href="../../../../org/opensolaris/os/dtrace/Option.html#cpp"><code>cpp</code></a> option, specifies which <code>cpp</code> to run by its pathname (compile-time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#cpu">cpu</a></span></code>
<div class="block">CPU on which to enable tracing (scalar).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#defaultargs">defaultargs</a></span></code>
<div class="block">Use zero (0) or empty string ("") as the value for unspecified macro args
(compile-time; no option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#define">define</a></span></code>
<div class="block">Define symbol when invoking preprocssor (compile-time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#destructive">destructive</a></span></code>
<div class="block">Permit destructive actions (no option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#dynvarsize">dynvarsize</a></span></code>
<div class="block">Dynamic variable space size (size).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#empty">empty</a></span></code>
<div class="block">Permit compilation of empty D source files (compile-time; no
option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#errtags">errtags</a></span></code>
<div class="block">Adds error tags to default error messages (compile-time; no
option value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent">flowindent</a></span></code>
<div class="block">Adds <a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace"><code>Flow</code></a> information to generated <a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace"><code>ProbeData</code></a>
indicating direction of control flow (entry or return) across
function boundaries and depth in call stack (no option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#incdir">incdir</a></span></code>
<div class="block">Add include directory to preprocessor search path (compile-time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#knodefs">knodefs</a></span></code>
<div class="block">Permit unresolved kernel symbols (compile-time; no option value).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#libdir">libdir</a></span></code>
<div class="block">Add library directory to library search path (compile-time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#nspec">nspec</a></span></code>
<div class="block">Number of speculations (scalar).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#quiet">quiet</a></span></code>
<div class="block">Only output explicitly traced data (no option value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#specsize">specsize</a></span></code>
<div class="block">Speculation buffer size (size).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#stackframes">stackframes</a></span></code>
<div class="block">Number of stack frames (scalar).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#statusrate">statusrate</a></span></code>
<div class="block">Rate of status checking (time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#stdc">stdc</a></span></code>
<div class="block">Specify ISO C conformance settings for preprocessor
(compile-time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#strsize">strsize</a></span></code>
<div class="block">String size (size).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#switchrate">switchrate</a></span></code>
<div class="block">Rate of buffer switching (time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#undef">undef</a></span></code>
<div class="block">Undefine symbol when invoking preprocessor (compile-time).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#unodefs">unodefs</a></span></code>
<div class="block">Permit unresolved user symbols (compile-time; no option value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#UNSET">UNSET</a></span></code>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> when
the given boolean option is unset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#ustackframes">ustackframes</a></span></code>
<div class="block">Number of user stack frames (scalar).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_AUTO">VALUE_AUTO</a></span></code>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> default value: use <code>auto</code> buffer
resizing policy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_FILL">VALUE_FILL</a></span></code>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> value: use <code>fill</code> princical buffer
policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_MANUAL">VALUE_MANUAL</a></span></code>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> value: use <code>manual</code> buffer resizing
policy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_RING">VALUE_RING</a></span></code>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> value: use <code>ring</code> princical buffer
policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SET">VALUE_SET</a></span></code>
<div class="block">May be passed to <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-java.lang.String-"><code>Consumer.setOption(String option, String
value)</code></a> to set a boolean option such as <a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>flowindent</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SWITCH">VALUE_SWITCH</a></span></code>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> default value: use <code>switch</code> princical
buffer policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_UNSET">VALUE_UNSET</a></span></code>
<div class="block">May be passed to <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-java.lang.String-"><code>Consumer.setOption(String option, String
value)</code></a> to unset a boolean option such as <a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>flowindent</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#version">version</a></span></code>
<div class="block">Request specific version of native DTrace library (compile-time).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#zdefs">zdefs</a></span></code>
<div class="block">Permit probe definitions that match zero probes (compile-time; no
option value).</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/Option.html#Option-java.lang.String-">Option</a></span>(java.lang.String optionName)</code>
<div class="block">Creates an option without an associated value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#Option-java.lang.String-java.lang.String-">Option</a></span>(java.lang.String optionName,
java.lang.String optionValue)</code>
<div class="block">Creates an option with the given name and value.</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>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#days-int-">days</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of days.</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/Option.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this option for equality.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#gb-int-">gb</a></span>(int n)</code>
<div class="block">Gets a size option value indicating the given number of
gigabytes.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#getName--">getName</a></span>()</code>
<div class="block">Gets the option name.</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/Option.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the option value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal options have equal hashcodes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#hours-int-">hours</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of hours.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#hz-int-">hz</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given rate per second.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#kb-int-">kb</a></span>(int n)</code>
<div class="block">Gets a size option value indicating the given number of
kilobytes.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#mb-int-">mb</a></span>(int n)</code>
<div class="block">Gets a size option value indicating the given number of
megabytes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#micros-int-">micros</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of
microseconds.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#millis-int-">millis</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of
milliseconds.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#minutes-int-">minutes</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of minutes.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#nanos-int-">nanos</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of
nanoseconds.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#seconds-int-">seconds</a></span>(int n)</code>
<div class="block">Gets a time option value indicating the given number of seconds.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#tb-int-">tb</a></span>(int n)</code>
<div class="block">Gets a size option value indicating the given number of
terabytes.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Option.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this option useful for logging
and not intended for display.</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="UNSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNSET</h4>
<pre>public static final long UNSET</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> when
the given boolean option is unset.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.UNSET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BUFPOLICY_RING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUFPOLICY_RING</h4>
<pre>public static final long BUFPOLICY_RING</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_RING"><code>ring</code></a>
buffer policy is set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.BUFPOLICY_RING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BUFPOLICY_FILL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUFPOLICY_FILL</h4>
<pre>public static final long BUFPOLICY_FILL</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_FILL"><code>fill</code></a>
buffer policy is set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.BUFPOLICY_FILL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BUFPOLICY_SWITCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUFPOLICY_SWITCH</h4>
<pre>public static final long BUFPOLICY_SWITCH</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> option when the default <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SWITCH"><code>switch</code></a> buffer policy is set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.BUFPOLICY_SWITCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BUFRESIZE_AUTO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUFRESIZE_AUTO</h4>
<pre>public static final long BUFRESIZE_AUTO</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> option when the default <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_AUTO"><code>auto</code></a> buffer resize policy is set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.BUFRESIZE_AUTO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BUFRESIZE_MANUAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUFRESIZE_MANUAL</h4>
<pre>public static final long BUFRESIZE_MANUAL</pre>
<div class="block">Value returned by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#getOption-java.lang.String-"><code>Consumer.getOption(String option)</code></a> for
the <a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> option when the <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_MANUAL"><code>manual</code></a> buffer resize policy is set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.BUFRESIZE_MANUAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_SET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_SET</h4>
<pre>public static final java.lang.String VALUE_SET</pre>
<div class="block">May be passed to <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-java.lang.String-"><code>Consumer.setOption(String option, String
value)</code></a> to set a boolean option such as <a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>flowindent</code></a>.
However, a more convenient way to set boolean options is <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-"><code>Consumer.setOption(String option)</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_SET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_UNSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_UNSET</h4>
<pre>public static final java.lang.String VALUE_UNSET</pre>
<div class="block">May be passed to <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#setOption-java.lang.String-java.lang.String-"><code>Consumer.setOption(String option, String
value)</code></a> to unset a boolean option such as <a href="../../../../org/opensolaris/os/dtrace/Option.html#flowindent"><code>flowindent</code></a>.
However, a more convenient way to unset boolean options is <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#unsetOption-java.lang.String-"><code>Consumer.unsetOption(String option)</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_UNSET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_RING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_RING</h4>
<pre>public static final java.lang.String VALUE_RING</pre>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> value: use <code>ring</code> princical buffer
policy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_RING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_FILL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_FILL</h4>
<pre>public static final java.lang.String VALUE_FILL</pre>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> value: use <code>fill</code> princical buffer
policy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_FILL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_SWITCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_SWITCH</h4>
<pre>public static final java.lang.String VALUE_SWITCH</pre>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufpolicy"><code>bufpolicy</code></a> default value: use <code>switch</code> princical
buffer policy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_SWITCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_AUTO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_AUTO</h4>
<pre>public static final java.lang.String VALUE_AUTO</pre>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> default value: use <code>auto</code> buffer
resizing policy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_AUTO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VALUE_MANUAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_MANUAL</h4>
<pre>public static final java.lang.String VALUE_MANUAL</pre>
<div class="block"><a href="../../../../org/opensolaris/os/dtrace/Option.html#bufresize"><code>bufresize</code></a> value: use <code>manual</code> buffer resizing
policy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.VALUE_MANUAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="amin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>amin</h4>
<pre>public static final java.lang.String amin</pre>
<div class="block">Set program attribute minimum (compile-time). The format of the
option value is defined by the <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#toString--"><code>InterfaceAttributes.toString()</code></a> method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Program.html#getInfo--"><code>Program.getInfo()</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.amin">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="argref">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>argref</h4>
<pre>public static final java.lang.String argref</pre>
<div class="block">Do not require all macro args to be used (compile-time; no option
value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.lang.String-java.lang.String...-"><code>Consumer.compile(String program, String[] macroArgs)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.io.File-java.lang.String...-"><code>Consumer.compile(File program, String[] macroArgs)</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.argref">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="cpp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpp</h4>
<pre>public static final java.lang.String cpp</pre>
<div class="block">Run cpp(1) preprocessor on D script files (compile-time; no
option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.cpp">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="cpppath">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpppath</h4>
<pre>public static final java.lang.String cpppath</pre>
<div class="block">Used together with <a href="../../../../org/opensolaris/os/dtrace/Option.html#cpp"><code>cpp</code></a> option, specifies which <code>cpp</code> to run by its pathname (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.cpppath">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="defaultargs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultargs</h4>
<pre>public static final java.lang.String defaultargs</pre>
<div class="block">Use zero (0) or empty string ("") as the value for unspecified macro args
(compile-time; no option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.lang.String-java.lang.String...-"><code>Consumer.compile(String program, String[] macroArgs)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html#compile-java.io.File-java.lang.String...-"><code>Consumer.compile(File program, String[] macroArgs)</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.defaultargs">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="define">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>define</h4>
<pre>public static final java.lang.String define</pre>
<div class="block">Define symbol when invoking preprocssor (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.define">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="empty">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre>public static final java.lang.String empty</pre>
<div class="block">Permit compilation of empty D source files (compile-time; no
option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.empty">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="errtags">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>errtags</h4>
<pre>public static final java.lang.String errtags</pre>
<div class="block">Adds error tags to default error messages (compile-time; no
option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.errtags">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="incdir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incdir</h4>
<pre>public static final java.lang.String incdir</pre>
<div class="block">Add include directory to preprocessor search path (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.incdir">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="knodefs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>knodefs</h4>
<pre>public static final java.lang.String knodefs</pre>
<div class="block">Permit unresolved kernel symbols (compile-time; no option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.knodefs">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="libdir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>libdir</h4>
<pre>public static final java.lang.String libdir</pre>
<div class="block">Add library directory to library search path (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.libdir">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="stdc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stdc</h4>
<pre>public static final java.lang.String stdc</pre>
<div class="block">Specify ISO C conformance settings for preprocessor
(compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.stdc">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="undef">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>undef</h4>
<pre>public static final java.lang.String undef</pre>
<div class="block">Undefine symbol when invoking preprocessor (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.undef">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="unodefs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unodefs</h4>
<pre>public static final java.lang.String unodefs</pre>
<div class="block">Permit unresolved user symbols (compile-time; no option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.unodefs">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="version">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public static final java.lang.String version</pre>
<div class="block">Request specific version of native DTrace library (compile-time).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.version">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="zdefs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zdefs</h4>
<pre>public static final java.lang.String zdefs</pre>
<div class="block">Permit probe definitions that match zero probes (compile-time; no
option value).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.zdefs">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggrate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggrate</h4>
<pre>public static final java.lang.String aggrate</pre>
<div class="block">Rate of aggregation reading (time). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggrate">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggsize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggsize</h4>
<pre>public static final java.lang.String aggsize</pre>
<div class="block">Aggregation buffer size (size). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggsize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggsortkey">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggsortkey</h4>
<pre>public static final java.lang.String aggsortkey</pre>
<div class="block">Denotes that aggregation data should be sorted in tuple order,
with ties broken by value order (no option value). Runtime
option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html" title="class in org.opensolaris.os.dtrace"><code>AggregationRecord</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>aggsortkeypos</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>aggsortpos</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>aggsortrev</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggsortkey">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggsortkeypos">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggsortkeypos</h4>
<pre>public static final java.lang.String aggsortkeypos</pre>
<div class="block">When multiple aggregation tuple elements are present, the
position of the tuple element that should act as the primary sort
key (zero-based index). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>aggsortkey</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>aggsortpos</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>aggsortrev</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggsortkeypos">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggsortpos">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggsortpos</h4>
<pre>public static final java.lang.String aggsortpos</pre>
<div class="block">When multiple aggregations are being printed, the position of the
aggregation that should act as the primary sort key (zero-based
index). Runtime option.
<p>
Here "position" refers to the position of the aggregation in the
<code>printa()</code> argument list after the format string (if
any). For example, given the following statement:
<pre><code>
printa("%d %@7d %@7d\n", @a, @b);
</code></pre>
setting <code>aggsortpos</code> to <code>"0"</code> indicates that output
should be sorted using the values of <code>@a</code> as the primary
sort key, while setting <code>aggsortpos</code> to <code>"1"</code>
indicates that output should be sorted using the values of
<code>@b</code> as the primary sort key.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>aggsortkey</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>aggsortkeypos</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>aggsortrev</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggsortpos">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="aggsortrev">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggsortrev</h4>
<pre>public static final java.lang.String aggsortrev</pre>
<div class="block">Denotes that aggregation data should be sorted in descending
order (no option value). Runtime option.
<p>
The <code>aggsortrev</code> option is useful in combination with the
<code>aggsortkey</code>, <code>aggsortkeypos</code>, and <code>aggsortpos</code>
options, which define the ascending sort reversed by this option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>aggsortkey</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>aggsortkeypos</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>aggsortpos</code></a>,
<a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.aggsortrev">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="bufsize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufsize</h4>
<pre>public static final java.lang.String bufsize</pre>
<div class="block">Principal buffer size (size). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.bufsize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="bufpolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufpolicy</h4>
<pre>public static final java.lang.String bufpolicy</pre>
<div class="block">Buffering policy (<a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SWITCH"><code>switch</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_FILL"><code>fill</code></a>, or <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_RING"><code>ring</code></a>). Runtime option.
<p>
See the <a
href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhr?a=view>
<b>Principal Buffer Policies</b></a> section of the
<b>Buffers and Buffering</b> chapter of the <i>Solaris Dynamic
Tracing Guide</i>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.bufpolicy">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="bufresize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufresize</h4>
<pre>public static final java.lang.String bufresize</pre>
<div class="block">Buffer resizing policy (<a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_AUTO"><code>auto</code></a> or <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_MANUAL"><code>manual</code></a>). Runtime option.
<p>
See the <a
href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhu?a=view>
<b>Buffer Resizing Policy</b></a> section of the <b>Buffers
and Buffering</b> chapter of the <i>Solaris Dynamic Tracing
Guide</i>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.bufresize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="cleanrate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanrate</h4>
<pre>public static final java.lang.String cleanrate</pre>
<div class="block">Cleaning rate (time). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.cleanrate">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="cpu">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpu</h4>
<pre>public static final java.lang.String cpu</pre>
<div class="block">CPU on which to enable tracing (scalar). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.cpu">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="destructive">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destructive</h4>
<pre>public static final java.lang.String destructive</pre>
<div class="block">Permit destructive actions (no option value). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.destructive">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="dynvarsize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dynvarsize</h4>
<pre>public static final java.lang.String dynvarsize</pre>
<div class="block">Dynamic variable space size (size). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.dynvarsize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="flowindent">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flowindent</h4>
<pre>public static final java.lang.String flowindent</pre>
<div class="block">Adds <a href="../../../../org/opensolaris/os/dtrace/Flow.html" title="class in org.opensolaris.os.dtrace"><code>Flow</code></a> information to generated <a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace"><code>ProbeData</code></a>
indicating direction of control flow (entry or return) across
function boundaries and depth in call stack (no option value).
Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.flowindent">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="nspec">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nspec</h4>
<pre>public static final java.lang.String nspec</pre>
<div class="block">Number of speculations (scalar). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.nspec">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="quiet">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>quiet</h4>
<pre>public static final java.lang.String quiet</pre>
<div class="block">Only output explicitly traced data (no option value). Makes no
difference to generated <a href="../../../../org/opensolaris/os/dtrace/ProbeData.html" title="class in org.opensolaris.os.dtrace"><code>ProbeData</code></a>, but user apps may use
the <code>quiet</code> flag as a rendering hint similar to the <code>-q</code> <code>dtrace(1M)</code> command option. Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.quiet">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="specsize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>specsize</h4>
<pre>public static final java.lang.String specsize</pre>
<div class="block">Speculation buffer size (size). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.specsize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="stackframes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stackframes</h4>
<pre>public static final java.lang.String stackframes</pre>
<div class="block">Number of stack frames (scalar). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.stackframes">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="statusrate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>statusrate</h4>
<pre>public static final java.lang.String statusrate</pre>
<div class="block">Rate of status checking (time). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.statusrate">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="strsize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>strsize</h4>
<pre>public static final java.lang.String strsize</pre>
<div class="block">String size (size). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.strsize">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="switchrate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>switchrate</h4>
<pre>public static final java.lang.String switchrate</pre>
<div class="block">Rate of buffer switching (time). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.switchrate">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ustackframes">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ustackframes</h4>
<pre>public static final java.lang.String ustackframes</pre>
<div class="block">Number of user stack frames (scalar). Runtime option.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.opensolaris.os.dtrace.Option.ustackframes">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Option-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Option</h4>
<pre>public Option(java.lang.String optionName)</pre>
<div class="block">Creates an option without an associated value. The created
boolean option has the value <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_SET"><code>VALUE_SET</code></a>. To
specify that the named option be unset, use <a href="../../../../org/opensolaris/os/dtrace/Option.html#VALUE_UNSET"><code>VALUE_UNSET</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>optionName</code> - DTrace option name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given option name is <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Option.html#Option-java.lang.String-java.lang.String-"><code>Option(String optionName, String optionValue)</code></a></dd>
</dl>
</li>
</ul>
<a name="Option-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Option</h4>
<pre>public Option(java.lang.String optionName,
java.lang.String optionValue)</pre>
<div class="block">Creates an option with the given name and value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>optionName</code> - DTrace option name</dd>
<dd><code>optionValue</code> - DTrace option value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given option name or value is
<code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="kb-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>kb</h4>
<pre>public static java.lang.String kb(int n)</pre>
<div class="block">Gets a size option value indicating the given number of
kilobytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of kilobytes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>size option value indicating the given number of
kilobytes</dd>
</dl>
</li>
</ul>
<a name="mb-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mb</h4>
<pre>public static java.lang.String mb(int n)</pre>
<div class="block">Gets a size option value indicating the given number of
megabytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of megabytes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>size option value indicating the given number of
megabytes</dd>
</dl>
</li>
</ul>
<a name="gb-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gb</h4>
<pre>public static java.lang.String gb(int n)</pre>
<div class="block">Gets a size option value indicating the given number of
gigabytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of gigabytes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>size option value indicating the given number of
gigabytes</dd>
</dl>
</li>
</ul>
<a name="tb-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tb</h4>
<pre>public static java.lang.String tb(int n)</pre>
<div class="block">Gets a size option value indicating the given number of
terabytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of terabytes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>size option value indicating the given number of
terabytes</dd>
</dl>
</li>
</ul>
<a name="nanos-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanos</h4>
<pre>public static java.lang.String nanos(int n)</pre>
<div class="block">Gets a time option value indicating the given number of
nanoseconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of nanoseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of
nanoseconds</dd>
</dl>
</li>
</ul>
<a name="micros-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>micros</h4>
<pre>public static java.lang.String micros(int n)</pre>
<div class="block">Gets a time option value indicating the given number of
microseconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of microseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of
microseconds</dd>
</dl>
</li>
</ul>
<a name="millis-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>millis</h4>
<pre>public static java.lang.String millis(int n)</pre>
<div class="block">Gets a time option value indicating the given number of
milliseconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of milliseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of
milliseconds</dd>
</dl>
</li>
</ul>
<a name="seconds-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seconds</h4>
<pre>public static java.lang.String seconds(int n)</pre>
<div class="block">Gets a time option value indicating the given number of seconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of seconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of seconds</dd>
</dl>
</li>
</ul>
<a name="minutes-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minutes</h4>
<pre>public static java.lang.String minutes(int n)</pre>
<div class="block">Gets a time option value indicating the given number of minutes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of minutes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of minutes</dd>
</dl>
</li>
</ul>
<a name="hours-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hours</h4>
<pre>public static java.lang.String hours(int n)</pre>
<div class="block">Gets a time option value indicating the given number of hours.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of hours</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of hours</dd>
</dl>
</li>
</ul>
<a name="days-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>days</h4>
<pre>public static java.lang.String days(int n)</pre>
<div class="block">Gets a time option value indicating the given number of days.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of days</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating the given number of days</dd>
</dl>
</li>
</ul>
<a name="hz-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hz</h4>
<pre>public static java.lang.String hz(int n)</pre>
<div class="block">Gets a time option value indicating the given rate per second.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - number of cycles per second (hertz)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time option value indicating rate per second</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 option name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null option name</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.String getValue()</pre>
<div class="block">Gets the option value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>option value, or <code>null</code> if no value is associated
with the option</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 option for equality.
Defines equality as having equal names and values.</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 the specified object is an
<code>Option</code> with the same name and the same value as this
option. Option values are the same if they are both <code>null</code>
or if they are equal as defined by <code>String.equals()</code>.</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 options 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 a string representation of this option 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:
<pre><code>
class-name[property1 = value1, property2 = value2]
</code></pre></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/Option.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/MinValue.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/PrintaRecord.html" title="class 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/Option.html" target="_top">Frames</a></li>
<li><a href="Option.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>Nested | </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>