| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/ProcessState.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>ProcessState</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="ProcessState";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/ProcessState.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/ProcessEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.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/ProcessState.html" target="_top">Frames</a></li>
<li><a href="ProcessState.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 ProcessState" class="title">Class ProcessState</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.ProcessState</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">ProcessState</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">State of a target process designated by <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#createProcess-java.lang.String-"><code>Consumer.createProcess(String command)</code></a> or <a href="../../../../org/opensolaris/os/dtrace/Consumer.html#grabProcess-int-"><code>Consumer.grabProcess(int pid)</code></a>.
<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/ConsumerListener.html#processStateChanged-org.opensolaris.os.dtrace.ProcessEvent-"><code>ConsumerListener.processStateChanged(ProcessEvent e)</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.ProcessState">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/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace">ProcessState.State</a></span></code>
<div class="block">State of a target process.</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/ProcessState.html#ProcessState-int-org.opensolaris.os.dtrace.ProcessState.State-int-java.lang.String-java.lang.Integer-java.lang.String-">ProcessState</a></span>(int pid,
<a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace">ProcessState.State</a> processState,
int processTerminationSignal,
java.lang.String processTerminationSignalName,
java.lang.Integer processExitStatus,
java.lang.String msg)</code>
<div class="block">Creates a <code>ProcessState</code> instance with the given state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#ProcessState-int-java.lang.String-int-java.lang.String-java.lang.Integer-java.lang.String-">ProcessState</a></span>(int pid,
java.lang.String processStateName,
int processTerminationSignal,
java.lang.String processTerminationSignalName,
java.lang.Integer processExitStatus,
java.lang.String msg)</code>
<div class="block">Supports XML persistence.</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/ProcessState.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this <code>ProcessState</code>
instance for equality.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#getExitStatus--">getExitStatus</a></span>()</code>
<div class="block">Gets the process exit status.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#getMessage--">getMessage</a></span>()</code>
<div class="block">Gets the message from DTrace describing this process state.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#getProcessID--">getProcessID</a></span>()</code>
<div class="block">Gets the process ID.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace">ProcessState.State</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#getState--">getState</a></span>()</code>
<div class="block">Gets the process state.</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/ProcessState.html#getTerminationSignal--">getTerminationSignal</a></span>()</code>
<div class="block">Gets the signal that terminated the process.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#getTerminationSignalName--">getTerminationSignalName</a></span>()</code>
<div class="block">Gets the name of the signal that terminated the process.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal instances have equal hash codes.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this process state 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProcessState-int-org.opensolaris.os.dtrace.ProcessState.State-int-java.lang.String-java.lang.Integer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcessState</h4>
<pre>public ProcessState(int pid,
<a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace">ProcessState.State</a> processState,
int processTerminationSignal,
java.lang.String processTerminationSignalName,
java.lang.Integer processExitStatus,
java.lang.String msg)</pre>
<div class="block">Creates a <code>ProcessState</code> instance with the given state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - non-negative target process ID</dd>
<dd><code>processState</code> - target process state</dd>
<dd><code>processTerminationSignal</code> - signal that terminated the target
process, <code>-1</code> if the process was not terminated by a signal
or if the terminating signal is unknown</dd>
<dd><code>processTerminationSignalName</code> - name of the signal that
terminated the target process, <code>null</code> if the process was
not terminated by a signal or if the terminating signal is
unknown</dd>
<dd><code>processExitStatus</code> - target process exit status, <code>null</code>
if the process has not exited or the exit status is unknown</dd>
<dd><code>msg</code> - message included by DTrace, if any</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given process state is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given process ID is negative</dd>
</dl>
</li>
</ul>
<a name="ProcessState-int-java.lang.String-int-java.lang.String-java.lang.Integer-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProcessState</h4>
<pre>public ProcessState(int pid,
java.lang.String processStateName,
int processTerminationSignal,
java.lang.String processTerminationSignalName,
java.lang.Integer processExitStatus,
java.lang.String msg)</pre>
<div class="block">Supports XML persistence.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there is no <a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace"><code>ProcessState.State</code></a> value with the given state name.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ProcessState.html#ProcessState-int-org.opensolaris.os.dtrace.ProcessState.State-int-java.lang.String-java.lang.Integer-java.lang.String-"><code>ProcessState(int pid, State processState, int
processTerminationSignal, String processTerminationSignalName,
Integer processExitStatus, String msg)</code></a></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="getProcessID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessID</h4>
<pre>public int getProcessID()</pre>
<div class="block">Gets the process ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative target process ID</dd>
</dl>
</li>
</ul>
<a name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.html" title="enum in org.opensolaris.os.dtrace">ProcessState.State</a> getState()</pre>
<div class="block">Gets the process state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null target process state</dd>
</dl>
</li>
</ul>
<a name="getTerminationSignal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTerminationSignal</h4>
<pre>public int getTerminationSignal()</pre>
<div class="block">Gets the signal that terminated the process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>termination signal, <code>-1</code> if the process was not
terminated by a signal or if the terminating signal is unknown</dd>
</dl>
</li>
</ul>
<a name="getTerminationSignalName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTerminationSignalName</h4>
<pre>public java.lang.String getTerminationSignalName()</pre>
<div class="block">Gets the name of the signal that terminated the process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>termination signal name, <code>null</code> if the process was
not terminated by a signal or if the terminating signal is
unknown</dd>
</dl>
</li>
</ul>
<a name="getExitStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExitStatus</h4>
<pre>public java.lang.Integer getExitStatus()</pre>
<div class="block">Gets the process exit status.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>exit status, or <code>null</code> if the process has not
exited or the exit status is unknown</dd>
</dl>
</li>
</ul>
<a name="getMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>public java.lang.String getMessage()</pre>
<div class="block">Gets the message from DTrace describing this process state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DTrace message, or <code>null</code> if DTrace did not include
a message with this process state</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 <code>ProcessState</code>
instance 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
a <code>ProcessState</code> and both instances have the same
attributes</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 instances have equal hash codes.</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 process state 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/ProcessState.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/ProcessEvent.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/ProcessState.State.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/ProcessState.html" target="_top">Frames</a></li>
<li><a href="ProcessState.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>