/usr/share/doc/libtruffle-java/api/com/oracle/truffle/api/dsl/TypeCheck.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 | <!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:09 UTC 2015 -->
<title>TypeCheck</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="TypeCheck";
}
//-->
</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><a href="../../../../../com/oracle/truffle/api/dsl/TypeCast.html" title="annotation in com.oracle.truffle.api.dsl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/oracle/truffle/api/dsl/TypeSystem.html" title="annotation in com.oracle.truffle.api.dsl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/oracle/truffle/api/dsl/TypeCheck.html" target="_top">Frames</a></li>
<li><a href="TypeCheck.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>Required | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Element</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.dsl</div>
<h2 title="Annotation Type TypeCheck" class="title">Annotation Type TypeCheck</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=CLASS)
@Target(value=METHOD)
public @interface <span class="strong">TypeCheck</span></pre>
<div class="block"><p>
Provides a way to define a custom type check for a defined type. The name of the annotated method
must fit to the pattern is${typeName} (eg. isInteger), where ${typeName} must be a valid type
defined in the parent <a href="../../../../../com/oracle/truffle/api/dsl/TypeSystem.html" title="annotation in com.oracle.truffle.api.dsl"><code>TypeSystem</code></a>. The annotated method must have exactly one argument
where the type of the argument is the generic type <code>Object</code> or a more specific one from the
<a href="../../../../../com/oracle/truffle/api/dsl/TypeSystem.html" title="annotation in com.oracle.truffle.api.dsl"><code>TypeSystem</code></a>. You can define multiple overloaded <a href="../../../../../com/oracle/truffle/api/dsl/TypeCheck.html" title="annotation in com.oracle.truffle.api.dsl"><code>TypeCheck</code></a> methods for the same
type. This can be used to reduce the boxing overhead in type conversions.
</p>
<p>
By default the system generates type checks for all types in the parent <a href="../../../../../com/oracle/truffle/api/dsl/TypeSystem.html" title="annotation in com.oracle.truffle.api.dsl"><code>TypeSystem</code></a> which
look like the follows:
<pre>
@TypeCheck
boolean is${typeName}(Object value) {
return value instanceof ${typeName};
}
</pre>
<b>Example:</b>
<p>
A type check for BigInteger with one overloaded optimized variant to reduce boxing.
</p>
<pre>
@TypeSystem(types = {int.class, BigInteger.class, String.class}, nodeBaseClass = TypedNode.class)
public abstract class Types {
@TypeCheck
public boolean isBigInteger(Object value) {
return value instanceof Integer || value instanceof BigInteger;
}
@TypeCheck
public boolean isBigInteger(int value) {
return true;
}
}
</pre></div>
</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><a href="../../../../../com/oracle/truffle/api/dsl/TypeCast.html" title="annotation in com.oracle.truffle.api.dsl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/oracle/truffle/api/dsl/TypeSystem.html" title="annotation in com.oracle.truffle.api.dsl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/oracle/truffle/api/dsl/TypeCheck.html" target="_top">Frames</a></li>
<li><a href="TypeCheck.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>Required | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Element</li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|