/usr/share/doc/libtruffle-java/api/com/oracle/truffle/api/Assumption.html is in libtruffle-java-doc 0.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | <!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 (version 1.7.0_79) on Thu May 07 00:06:08 UTC 2015 -->
<title>Assumption</title>
<meta name="date" content="2015-05-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Assumption";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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>Prev Class</li>
<li><a href="../../../../com/oracle/truffle/api/CallTarget.html" title="interface in com.oracle.truffle.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/oracle/truffle/api/Assumption.html" target="_top">Frames</a></li>
<li><a href="Assumption.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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">com.oracle.truffle.api</div>
<h2 title="Interface Assumption" class="title">Interface Assumption</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/oracle/truffle/api/impl/AbstractAssumption.html" title="class in com.oracle.truffle.api.impl">AbstractAssumption</a>, <a href="../../../../com/oracle/truffle/api/utilities/AlwaysValidAssumption.html" title="class in com.oracle.truffle.api.utilities">AlwaysValidAssumption</a>, <a href="../../../../com/oracle/truffle/api/utilities/NeverValidAssumption.html" title="class in com.oracle.truffle.api.utilities">NeverValidAssumption</a>, <a href="../../../../com/oracle/truffle/api/utilities/UnionAssumption.html" title="class in com.oracle.truffle.api.utilities">UnionAssumption</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Assumption</span></pre>
<div class="block">An assumption is a global boolean flag that starts with the value true (i.e., the assumption is
valid) and can subsequently be invalidated (using <a href="../../../../com/oracle/truffle/api/Assumption.html#invalidate()"><code>invalidate()</code></a>). Once
invalidated, an assumption can never get valid again. Assumptions can be created using the
<a href="../../../../com/oracle/truffle/api/TruffleRuntime.html#createAssumption()"><code>TruffleRuntime.createAssumption()</code></a> or the <a href="../../../../com/oracle/truffle/api/TruffleRuntime.html#createAssumption(java.lang.String)"><code>TruffleRuntime.createAssumption(String)</code></a>
method. The Truffle compiler has special knowledge of this class in order to produce efficient
machine code for checking an assumption in case the assumption object is a compile time constant.
Therefore, assumptions should be stored in final fields in Truffle nodes.
All instances of classes implementing <code>Assumption</code> must be held in <code>final</code> fields for
compiler optimizations to take effect.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/oracle/truffle/api/Assumption.html#check()">check</a></strong>()</code>
<div class="block">Checks that this assumption is still valid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/oracle/truffle/api/Assumption.html#getName()">getName</a></strong>()</code>
<div class="block">A name for the assumption that is used for debug output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/oracle/truffle/api/Assumption.html#invalidate()">invalidate</a></strong>()</code>
<div class="block">Invalidates this assumption.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/oracle/truffle/api/Assumption.html#isValid()">isValid</a></strong>()</code>
<div class="block">Checks whether the assumption is still valid.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="check()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>check</h4>
<pre>void check()
throws <a href="../../../../com/oracle/truffle/api/nodes/InvalidAssumptionException.html" title="class in com.oracle.truffle.api.nodes">InvalidAssumptionException</a></pre>
<div class="block">Checks that this assumption is still valid. The method throws an exception, if this is no
longer the case. This method is preferred over the <a href="../../../../com/oracle/truffle/api/Assumption.html#isValid()"><code>isValid()</code></a> method when writing
guest language interpreter code. The catch block should perform a node rewrite (see
<a href="../../../../com/oracle/truffle/api/nodes/Node.html#replace(T)"><code>Node.replace(Node)</code></a>) with a node that no longer relies on the assumption.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/oracle/truffle/api/nodes/InvalidAssumptionException.html" title="class in com.oracle.truffle.api.nodes">InvalidAssumptionException</a></code> - If the assumption is no longer valid.</dd></dl>
</li>
</ul>
<a name="isValid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>boolean isValid()</pre>
<div class="block">Checks whether the assumption is still valid.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a boolean value indicating the validity of the assumption</dd></dl>
</li>
</ul>
<a name="invalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidate</h4>
<pre>void invalidate()</pre>
<div class="block">Invalidates this assumption. Performs no operation, if the assumption is already invalid.</div>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">A name for the assumption that is used for debug output.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the assumption</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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>Prev Class</li>
<li><a href="../../../../com/oracle/truffle/api/CallTarget.html" title="interface in com.oracle.truffle.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/oracle/truffle/api/Assumption.html" target="_top">Frames</a></li>
<li><a href="Assumption.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|