/usr/share/doc/libaopalliance-java/api/org/aopalliance/reflect/Code.html is in libaopalliance-java-doc 20070526-5.
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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Fri Jan 27 13:19:21 UTC 2012 -->
<TITLE>
Code
</TITLE>
<META NAME="date" CONTENT="2012-01-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Code";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/aopalliance/reflect/ClassLocator.html" title="interface in org.aopalliance.reflect"><B>PREV CLASS</B></A>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/aopalliance/reflect/Code.html" target="_top"><B>FRAMES</B></A>
<A HREF="Code.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.aopalliance.reflect</FONT>
<BR>
Interface Code</H2>
<HR>
<DL>
<DT><PRE>public interface <B>Code</B></DL>
</PRE>
<P>
This represents a piece of code in the program.
<p>It is formed of a set of instructions and can be implemented at
bytecode or source-code level.
<p>Typically, a code in the program comes from method bodies (it
can be init methods (instance or static) or regular methods
(instance or static) with any kind of visibility modifiers (public,
protected, private).
<p>So, this class allows the client to retrieve code locators on
instructions within this code. This locators shall be used
conjointly whith an <A HREF="../../../org/aopalliance/instrument/Instrumentor.html" title="interface in org.aopalliance.instrument"><CODE>Instrumentor</CODE></A>
implementation in order to perform aspetual transformations of the
program (before/after/around type).
<p>The <A HREF="../../../org/aopalliance/reflect/Code.html#getLocator()"><CODE>getLocator()</CODE></A> method returns the locator for the whole
method and can be used to implement callee-side transformations
before/after/around the callee method.
<p>The other set of locating methods returns locators that allows
the client to implement caller-side transformations (e.g. when the
code accesses a field or calls a method).
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../org/aopalliance/instrument/Instrumentor.html" title="interface in org.aopalliance.instrument"><CODE>Instrumentor</CODE></A>,
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect"><CODE>CodeLocator</CODE></A>,
<A HREF="../../../org/aopalliance/reflect/Method.html#getBody()"><CODE>Method.getBody()</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getCallLocator(org.aopalliance.reflect.Method)">getCallLocator</A></B>(<A HREF="../../../org/aopalliance/reflect/Method.html" title="interface in org.aopalliance.reflect">Method</A> calleeMethod)</CODE>
<BR>
Returns a call locator for the given callee method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getCatchLocator(org.aopalliance.reflect.Class)">getCatchLocator</A></B>(<A HREF="../../../org/aopalliance/reflect/Class.html" title="interface in org.aopalliance.reflect">Class</A> exceptionType)</CODE>
<BR>
Returns a exception catching locator in the current body.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getLocator()">getLocator</A></B>()</CODE>
<BR>
Returns the code locator that corresponds to this code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getReadLocator(org.aopalliance.reflect.Field)">getReadLocator</A></B>(<A HREF="../../../org/aopalliance/reflect/Field.html" title="interface in org.aopalliance.reflect">Field</A> readField)</CODE>
<BR>
Returns a field reading locator in the current body.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getThrowLocator(org.aopalliance.reflect.Class)">getThrowLocator</A></B>(<A HREF="../../../org/aopalliance/reflect/Class.html" title="interface in org.aopalliance.reflect">Class</A> exceptionType)</CODE>
<BR>
Returns a exception throwing locator in the current body.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/aopalliance/reflect/Code.html#getWriteLocator(org.aopalliance.reflect.Field)">getWriteLocator</A></B>(<A HREF="../../../org/aopalliance/reflect/Field.html" title="interface in org.aopalliance.reflect">Field</A> writtenField)</CODE>
<BR>
Returns a field writing locator in the current body.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLocator()"><!-- --></A><H3>
getLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getLocator</B>()</PRE>
<DL>
<DD>Returns the code locator that corresponds to this code.
<p>For instance, if a code is a set of instructions called
<code>code</code>, then the locator will designate
<code><code></code>.
<p> This locator is typically used to locate a whole method body.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../org/aopalliance/reflect/Method.html#getBody()"><CODE>Method.getBody()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getCallLocator(org.aopalliance.reflect.Method)"><!-- --></A><H3>
getCallLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getCallLocator</B>(<A HREF="../../../org/aopalliance/reflect/Method.html" title="interface in org.aopalliance.reflect">Method</A> calleeMethod)</PRE>
<DL>
<DD>Returns a call locator for the given callee method.
<p>For instance, a call locator for method <code>m()</code>
designates the parts between <code><></code> in the
following code.
<pre class=code>
[...]
aLocalVariable.<m()>;
[...]
aMethodParameter.<m()>;
[...]
aField.<m()>;
[...]
<m()> // when m is a method of the class the current code belongs to
[...]
</pre>
<p>If the given method is a static method, the locator follows
the same principles, as for constructors. For instance if the
current method is the <code>init</code> method of class
<code>C</code>:
<pre class=code>
[...]
aVar = <new C()>;
[...]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>calleeMethod</CODE> - the method that is called from the current
code</DL>
</DD>
</DL>
<HR>
<A NAME="getReadLocator(org.aopalliance.reflect.Field)"><!-- --></A><H3>
getReadLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getReadLocator</B>(<A HREF="../../../org/aopalliance/reflect/Field.html" title="interface in org.aopalliance.reflect">Field</A> readField)</PRE>
<DL>
<DD>Returns a field reading locator in the current body.
<p>For instance, a field read locator for field <code>f</code>
designates the parts between <code><></code> in the
following code.
<pre>
[...]
<f>.m();
[...]
aVarOrFieldOrParam = <f>;
[...]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>readField</CODE> - the field that is read from the current code</DL>
</DD>
</DL>
<HR>
<A NAME="getWriteLocator(org.aopalliance.reflect.Field)"><!-- --></A><H3>
getWriteLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getWriteLocator</B>(<A HREF="../../../org/aopalliance/reflect/Field.html" title="interface in org.aopalliance.reflect">Field</A> writtenField)</PRE>
<DL>
<DD>Returns a field writing locator in the current body.
<p>For instance, a field write locator for field <code>f</code>
designates the parts between <code><></code> in the
following code.
<pre>
[...]
<f=> aVarOrFieldOrParam;
[...]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writtenField</CODE> - the field that is written from the current
code</DL>
</DD>
</DL>
<HR>
<A NAME="getThrowLocator(org.aopalliance.reflect.Class)"><!-- --></A><H3>
getThrowLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getThrowLocator</B>(<A HREF="../../../org/aopalliance/reflect/Class.html" title="interface in org.aopalliance.reflect">Class</A> exceptionType)</PRE>
<DL>
<DD>Returns a exception throwing locator in the current body.
<p>For instance, an exception throw locator for exception of
type <code>E</code> designates the parts between
<code><></code> in the following code.
<pre>
[...]
<throw> new E();
[...]
throw new AnotherExceptionType();
[...]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exceptionType</CODE> - the type of the throwed exception</DL>
</DD>
</DL>
<HR>
<A NAME="getCatchLocator(org.aopalliance.reflect.Class)"><!-- --></A><H3>
getCatchLocator</H3>
<PRE>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect">CodeLocator</A> <B>getCatchLocator</B>(<A HREF="../../../org/aopalliance/reflect/Class.html" title="interface in org.aopalliance.reflect">Class</A> exceptionType)</PRE>
<DL>
<DD>Returns a exception catching locator in the current body.
<p>For instance, an exception catch locator for exception of
type <code>E</code> designates the parts between
<code><></code> in the following code.
<pre>
[...]
try {
[...]
} catch(E e1) {
<[...]>
} catch(AnotherExceptionType e2) { [...] };
[...]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exceptionType</CODE> - the type of the throwed exception</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/aopalliance/reflect/ClassLocator.html" title="interface in org.aopalliance.reflect"><B>PREV CLASS</B></A>
<A HREF="../../../org/aopalliance/reflect/CodeLocator.html" title="interface in org.aopalliance.reflect"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/aopalliance/reflect/Code.html" target="_top"><B>FRAMES</B></A>
<A HREF="Code.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|