| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/InterfaceAttributes.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>InterfaceAttributes</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="InterfaceAttributes";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All 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/InterfaceAttributes.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/Flow.Kind.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.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/InterfaceAttributes.html" target="_top">Frames</a></li>
<li><a href="InterfaceAttributes.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>Field | </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>Field | </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 InterfaceAttributes" class="title">Class InterfaceAttributes</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.InterfaceAttributes</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">InterfaceAttributes</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">Triplet of attributes consisting of two stability levels and a
dependency class. Attributes may vary independently. They use
labels described in the <code>attributes(5)</code> man page to help set
expectations for what kinds of changes might occur in different kinds
of future releases. The D compiler includes features to dynamically
compute the stability levels of D programs you create. For more
information, refer to the <a
href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlnp?a=view>
<b>Stability</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="../../../../org/opensolaris/os/dtrace/Consumer.html#getProgramInfo-org.opensolaris.os.dtrace.Program-"><code>Consumer.getProgramInfo(Program program)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html#enable-org.opensolaris.os.dtrace.Program-"><code>Consumer.enable(Program program)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html#listProbes-org.opensolaris.os.dtrace.ProbeDescription-"><code>Consumer.listProbes(ProbeDescription filter)</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Consumer.html#listProgramProbes-org.opensolaris.os.dtrace.Program-"><code>Consumer.listProgramProbes(Program program)</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.InterfaceAttributes">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/InterfaceAttributes.DependencyClass.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.DependencyClass</a></span></code>
<div class="block">Architectural dependency class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a></span></code>
<div class="block">Interface stability level.</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/InterfaceAttributes.html#InterfaceAttributes-org.opensolaris.os.dtrace.InterfaceAttributes.Stability-org.opensolaris.os.dtrace.InterfaceAttributes.Stability-org.opensolaris.os.dtrace.InterfaceAttributes.DependencyClass-">InterfaceAttributes</a></span>(<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> nameStabilityAttribute,
<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> dataStabilityAttribute,
<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.DependencyClass</a> dependencyClassAttribute)</code>
<div class="block">Creates an interface attribute triplet from the given attributes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#InterfaceAttributes-java.lang.String-java.lang.String-java.lang.String-">InterfaceAttributes</a></span>(java.lang.String nameStabilityAttributeName,
java.lang.String dataStabilityAttributeName,
java.lang.String dependencyClassAttributeName)</code>
<div class="block">Creates an interface attribute triplet from the given attribute
names.</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="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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this attribute triplet for
equality.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#getDataStability--">getDataStability</a></span>()</code>
<div class="block">Gets the stability level of the data format used by an interface
and any associated data semantics.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.DependencyClass</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#getDependencyClass--">getDependencyClass</a></span>()</code>
<div class="block">Gets the interface dependency class.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#getNameStability--">getNameStability</a></span>()</code>
<div class="block">Gets the stabiltiy level of an interface associated with its name
as it appears in a D program.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal <code>InterfaceAttributes</code>
instances have equal hashcodes.</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/InterfaceAttributes.html#toString--">toString</a></span>()</code>
<div class="block">Gets the string representation of this triplet of interface
attributes.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="InterfaceAttributes-org.opensolaris.os.dtrace.InterfaceAttributes.Stability-org.opensolaris.os.dtrace.InterfaceAttributes.Stability-org.opensolaris.os.dtrace.InterfaceAttributes.DependencyClass-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>InterfaceAttributes</h4>
<pre>public InterfaceAttributes(<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> nameStabilityAttribute,
<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> dataStabilityAttribute,
<a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.DependencyClass</a> dependencyClassAttribute)</pre>
<div class="block">Creates an interface attribute triplet from the given attributes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nameStabilityAttribute</code> - the stability level of the
interface associated with its name in a D program</dd>
<dd><code>dataStabilityAttribute</code> - stability of the data format used
by the interface and any associated data semantics</dd>
<dd><code>dependencyClassAttribute</code> - describes whether the interface
is specific to the current operating platform or microprocessor</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if any parameter is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="InterfaceAttributes-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InterfaceAttributes</h4>
<pre>public InterfaceAttributes(java.lang.String nameStabilityAttributeName,
java.lang.String dataStabilityAttributeName,
java.lang.String dependencyClassAttributeName)</pre>
<div class="block">Creates an interface attribute triplet from the given attribute
names. Supports XML persistence.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if any parameter is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if any parameter fails to match
an enumerated stability value</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="getNameStability--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameStability</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> getNameStability()</pre>
<div class="block">Gets the stabiltiy level of an interface associated with its name
as it appears in a D program. For example, the <code>execname</code>
D variable is a <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html#STABLE"><code>STABLE</code></a> name: Sun
guarantees this identifier will continue to be supported in D
programs according to the rules described for Stable interfaces.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the stability level of an interface associated with its
name as it appears in a D program</dd>
</dl>
</li>
</ul>
<a name="getDataStability--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataStability</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.Stability</a> getDataStability()</pre>
<div class="block">Gets the stability level of the data format used by an interface
and any associated data semantics. For example, the <code>pid</code>
D variable is a <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.Stability.html#STABLE"><code>STABLE</code></a> interface:
process IDs are a stable concept in Solaris, and Sun guarantees
that the <code>pid</code> variable will be of type <code>pid_t</code> with
the semantic that it is set to the process ID corresponding to
the thread that fired a given probe in accordance with the rules
described for Stable interfaces.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the stability level of the data format used by an
interface and any associated data semantics.</dd>
</dl>
</li>
</ul>
<a name="getDependencyClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDependencyClass</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.html" title="enum in org.opensolaris.os.dtrace">InterfaceAttributes.DependencyClass</a> getDependencyClass()</pre>
<div class="block">Gets the interface dependency class.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the dependency class describing whether the interface is
specific to the current operating platform or microprocessor</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 attribute triplet for
equality. Defines equality as having the same attributes.</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 also
an <code>InterfaceAttributes</code> instance and has all the same
attributes as this instance.</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 <code>InterfaceAttributes</code>
instances 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 triplet of interface
attributes. The format follows the convention described in the
<a href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlnt?a=view>
<b>Interface Attributes</b></a> section of the <b>Stability</b>
chapter of the <i>Solaris Dynamic Tracing Guide</i>. The
attributes appear in the following order, separated by slashes:
<pre><code>
<i>name-stability / data-stability / dependency-class</i>
</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/InterfaceAttributes.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/Flow.Kind.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/InterfaceAttributes.DependencyClass.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/InterfaceAttributes.html" target="_top">Frames</a></li>
<li><a href="InterfaceAttributes.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>Field | </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>Field | </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>