PageRenderTime 52ms CodeModel.GetById 39ms app.highlight 9ms RepoModel.GetById 0ms app.codeStats 1ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html

#
HTML | 330 lines | 284 code | 36 blank | 10 comment | 0 complexity | edef0957a14be8cf35641ad0b7cc1bd3 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:50 GMT-08:00 2008 -->
  6<TITLE>
  7ClassVisitor (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.bsh.org.objectweb.asm.ClassVisitor interface">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ClassVisitor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;PREV CLASS&nbsp;
 51&nbsp;<A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassWriter.html" title="class in org.gjt.sp.jedit.bsh.org.objectweb.asm"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../../../../index.html?org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="ClassVisitor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.bsh.org.objectweb.asm</FONT>
 78<BR>
 79Interface ClassVisitor</H2>
 80<DL>
 81<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassWriter.html" title="class in org.gjt.sp.jedit.bsh.org.objectweb.asm">ClassWriter</A></DD>
 82</DL>
 83<HR>
 84<DL>
 85<DT><PRE>public interface <B>ClassVisitor</B></DL>
 86</PRE>
 87
 88<P>
 89A visitor to visit a Java class. The methods of this interface must be called
 90 in the following order: <tt>visit</tt> (<tt>visitField</tt> |
 91 <tt>visitMethod</tt> | <tt>visitInnerClass</tt>)* <tt>visitEnd</tt>.
 92<P>
 93
 94<P>
 95<HR>
 96
 97<P>
 98
 99<!-- ========== METHOD SUMMARY =========== -->
100
101<A NAME="method_summary"><!-- --></A>
102<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
103<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
104<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
105<B>Method Summary</B></FONT></TH>
106</TR>
107<TR BGCOLOR="white" CLASS="TableRowColor">
108<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
109<CODE>&nbsp;void</CODE></FONT></TD>
110<TD><CODE><B><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html#visit(int, java.lang.String, java.lang.String, java.lang.String[], java.lang.String)">visit</A></B>(int&nbsp;access,
111      java.lang.String&nbsp;name,
112      java.lang.String&nbsp;superName,
113      java.lang.String[]&nbsp;interfaces,
114      java.lang.String&nbsp;sourceFile)</CODE>
115
116<BR>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits the header of the class.</TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>&nbsp;void</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html#visitEnd()">visitEnd</A></B>()</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits the end of the class.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;void</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html#visitField(int, java.lang.String, java.lang.String, java.lang.Object)">visitField</A></B>(int&nbsp;access,
131           java.lang.String&nbsp;name,
132           java.lang.String&nbsp;desc,
133           java.lang.Object&nbsp;value)</CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits a field of the class.</TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>&nbsp;void</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html#visitInnerClass(java.lang.String, java.lang.String, java.lang.String, int)">visitInnerClass</A></B>(java.lang.String&nbsp;name,
142                java.lang.String&nbsp;outerName,
143                java.lang.String&nbsp;innerName,
144                int&nbsp;access)</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits information about an inner class.</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;<A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/CodeVisitor.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm">CodeVisitor</A></CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html#visitMethod(int, java.lang.String, java.lang.String, java.lang.String[])">visitMethod</A></B>(int&nbsp;access,
153            java.lang.String&nbsp;name,
154            java.lang.String&nbsp;desc,
155            java.lang.String[]&nbsp;exceptions)</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits a method of the class.</TD>
159</TR>
160</TABLE>
161&nbsp;
162<P>
163
164<!-- ============ METHOD DETAIL ========== -->
165
166<A NAME="method_detail"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
170<B>Method Detail</B></FONT></TH>
171</TR>
172</TABLE>
173
174<A NAME="visit(int, java.lang.String, java.lang.String, java.lang.String[], java.lang.String)"><!-- --></A><H3>
175visit</H3>
176<PRE>
177void <B>visit</B>(int&nbsp;access,
178           java.lang.String&nbsp;name,
179           java.lang.String&nbsp;superName,
180           java.lang.String[]&nbsp;interfaces,
181           java.lang.String&nbsp;sourceFile)</PRE>
182<DL>
183<DD>Visits the header of the class.
184<P>
185<DD><DL>
186<DT><B>Parameters:</B><DD><CODE>access</CODE> - the class's access flags (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Constants.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>Constants</CODE></A>). This
187      parameter also indicates if the class is deprecated.<DD><CODE>name</CODE> - the internal name of the class (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>).<DD><CODE>superName</CODE> - the internal of name of the super class (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>). For interfaces, the super
188      class is <CODE>Object</CODE>. May be <tt>null</tt>, but only for the <CODE>java.lang.Object</CODE> class.<DD><CODE>interfaces</CODE> - the internal names of the class's interfaces (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>). May be <tt>null</tt>.<DD><CODE>sourceFile</CODE> - the name of the source file from which this class was
189      compiled. May be <tt>null</tt>.</DL>
190</DD>
191</DL>
192<HR>
193
194<A NAME="visitInnerClass(java.lang.String, java.lang.String, java.lang.String, int)"><!-- --></A><H3>
195visitInnerClass</H3>
196<PRE>
197void <B>visitInnerClass</B>(java.lang.String&nbsp;name,
198                     java.lang.String&nbsp;outerName,
199                     java.lang.String&nbsp;innerName,
200                     int&nbsp;access)</PRE>
201<DL>
202<DD>Visits information about an inner class. This inner class is not
203 necessarily a member of the class being visited.
204<P>
205<DD><DL>
206<DT><B>Parameters:</B><DD><CODE>name</CODE> - the internal name of an inner class (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>).<DD><CODE>outerName</CODE> - the internal name of the class to which the inner class
207      belongs (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>). May be
208      <tt>null</tt>.<DD><CODE>innerName</CODE> - the (simple) name of the inner class inside its enclosing
209      class. May be <tt>null</tt> for anonymous inner classes.<DD><CODE>access</CODE> - the access flags of the inner class as originally declared
210      in the enclosing class.</DL>
211</DD>
212</DL>
213<HR>
214
215<A NAME="visitField(int, java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3>
216visitField</H3>
217<PRE>
218void <B>visitField</B>(int&nbsp;access,
219                java.lang.String&nbsp;name,
220                java.lang.String&nbsp;desc,
221                java.lang.Object&nbsp;value)</PRE>
222<DL>
223<DD>Visits a field of the class.
224<P>
225<DD><DL>
226<DT><B>Parameters:</B><DD><CODE>access</CODE> - the field's access flags (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Constants.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>Constants</CODE></A>). This
227      parameter also indicates if the field is synthetic and/or deprecated.<DD><CODE>name</CODE> - the field's name.<DD><CODE>desc</CODE> - the field's descriptor (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html" title="class in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>Type</CODE></A>).<DD><CODE>value</CODE> - the field's initial value. This parameter, which may be
228      <tt>null</tt> if the field does not have an initial value, must be an
229      <CODE>Integer</CODE>, a <CODE>Float</CODE>, a
230      <CODE>Long</CODE>, a <CODE>Double</CODE> or a
231      <CODE>String</CODE>.</DL>
232</DD>
233</DL>
234<HR>
235
236<A NAME="visitMethod(int, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
237visitMethod</H3>
238<PRE>
239<A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/CodeVisitor.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm">CodeVisitor</A> <B>visitMethod</B>(int&nbsp;access,
240                        java.lang.String&nbsp;name,
241                        java.lang.String&nbsp;desc,
242                        java.lang.String[]&nbsp;exceptions)</PRE>
243<DL>
244<DD>Visits a method of the class. This method <i>must</i> return a new
245 <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/CodeVisitor.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>CodeVisitor</CODE></A> instance (or <tt>null</tt>) each time it
246 is called, i.e., it should not return a previously returned visitor.
247<P>
248<DD><DL>
249<DT><B>Parameters:</B><DD><CODE>access</CODE> - the method's access flags (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Constants.html" title="interface in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>Constants</CODE></A>). This
250      parameter also indicates if the method is synthetic and/or deprecated.<DD><CODE>name</CODE> - the method's name.<DD><CODE>desc</CODE> - the method's descriptor (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html" title="class in org.gjt.sp.jedit.bsh.org.objectweb.asm"><CODE>Type</CODE></A>).<DD><CODE>exceptions</CODE> - the internal names of the method's exception
251      classes (see <A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/Type.html#getInternalName()"><CODE>getInternalName</CODE></A>). May be
252      <tt>null</tt>.
253<DT><B>Returns:</B><DD>an object to visit the byte code of the method, or <tt>null</tt> if
254      this class visitor is not interested in visiting the code of this
255      method.</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="visitEnd()"><!-- --></A><H3>
261visitEnd</H3>
262<PRE>
263void <B>visitEnd</B>()</PRE>
264<DL>
265<DD>Visits the end of the class. This method, which is the last one to be
266 called, is used to inform the visitor that all the fields and methods of
267 the class have been visited.
268<P>
269<DD><DL>
270</DL>
271</DD>
272</DL>
273<!-- ========= END OF CLASS DATA ========= -->
274<HR>
275
276
277<!-- ======= START OF BOTTOM NAVBAR ====== -->
278<A NAME="navbar_bottom"><!-- --></A>
279<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
280<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
281<TR>
282<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
283<A NAME="navbar_bottom_firstrow"><!-- --></A>
284<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
285  <TR ALIGN="center" VALIGN="top">
286  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
287  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
288  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ClassVisitor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
290  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
291  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
292  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
293  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
294  </TR>
295</TABLE>
296</TD>
297<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
298</EM>
299</TD>
300</TR>
301
302<TR>
303<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
304&nbsp;PREV CLASS&nbsp;
305&nbsp;<A HREF="../../../../../../../../org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassWriter.html" title="class in org.gjt.sp.jedit.bsh.org.objectweb.asm"><B>NEXT CLASS</B></A></FONT></TD>
306<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
307  <A HREF="../../../../../../../../index.html?org/gjt/sp/jedit/bsh/org/objectweb/asm/ClassVisitor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
308&nbsp;<A HREF="ClassVisitor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
309&nbsp;
310<NOSCRIPT>
311  <A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
312</NOSCRIPT>
313
314
315</FONT></TD>
316</TR>
317<TR>
318<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
319  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
320<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
321DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
322</TR>
323</TABLE>
324<A NAME="skip-navbar_bottom"></A>
325<!-- ======== END OF BOTTOM NAVBAR ======= -->
326
327<HR>
328
329</BODY>
330</HTML>