001: /***
002: * ASM: a very small and fast Java bytecode manipulation framework
003: * Copyright (C) 2000 INRIA, France Telecom
004: * Copyright (C) 2002 France Telecom
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2 of the License, or (at your option) any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * Contact: Eric.Bruneton@rd.francetelecom.com
021: *
022: * Author: Eric Bruneton
023: */package bsh.org.objectweb.asm;
024:
025: /**
026: * A visitor to visit a Java class. The methods of this interface must be called
027: * in the following order: <tt>visit</tt> (<tt>visitField</tt> |
028: * <tt>visitMethod</tt> | <tt>visitInnerClass</tt>)* <tt>visitEnd</tt>.
029: */
030:
031: public interface ClassVisitor {
032:
033: /**
034: * Visits the header of the class.
035: *
036: * @param access the class's access flags (see {@link Constants}). This
037: * parameter also indicates if the class is deprecated.
038: * @param name the internal name of the class (see {@link Type#getInternalName
039: * getInternalName}).
040: * @param superName the internal of name of the super class (see {@link
041: * Type#getInternalName getInternalName}). For interfaces, the super
042: * class is {@link Object}. May be <tt>null</tt>, but only for the {@link
043: * Object java.lang.Object} class.
044: * @param interfaces the internal names of the class's interfaces (see {@link
045: * Type#getInternalName getInternalName}). May be <tt>null</tt>.
046: * @param sourceFile the name of the source file from which this class was
047: * compiled. May be <tt>null</tt>.
048: */
049:
050: void visit(int access, String name, String super Name,
051: String[] interfaces, String sourceFile);
052:
053: /**
054: * Visits information about an inner class. This inner class is not
055: * necessarily a member of the class being visited.
056: *
057: * @param name the internal name of an inner class (see {@link
058: * Type#getInternalName getInternalName}).
059: * @param outerName the internal name of the class to which the inner class
060: * belongs (see {@link Type#getInternalName getInternalName}). May be
061: * <tt>null</tt>.
062: * @param innerName the (simple) name of the inner class inside its enclosing
063: * class. May be <tt>null</tt> for anonymous inner classes.
064: * @param access the access flags of the inner class as originally declared
065: * in the enclosing class.
066: */
067:
068: void visitInnerClass(String name, String outerName,
069: String innerName, int access);
070:
071: /**
072: * Visits a field of the class.
073: *
074: * @param access the field's access flags (see {@link Constants}). This
075: * parameter also indicates if the field is synthetic and/or deprecated.
076: * @param name the field's name.
077: * @param desc the field's descriptor (see {@link Type Type}).
078: * @param value the field's initial value. This parameter, which may be
079: * <tt>null</tt> if the field does not have an initial value, must be an
080: * {@link java.lang.Integer Integer}, a {@link java.lang.Float Float}, a
081: * {@link java.lang.Long Long}, a {@link java.lang.Double Double} or a
082: * {@link String String}.
083: */
084:
085: void visitField(int access, String name, String desc, Object value);
086:
087: /**
088: * Visits a method of the class. This method <i>must</i> return a new
089: * {@link CodeVisitor CodeVisitor} instance (or <tt>null</tt>) each time it
090: * is called, i.e., it should not return a previously returned visitor.
091: *
092: * @param access the method's access flags (see {@link Constants}). This
093: * parameter also indicates if the method is synthetic and/or deprecated.
094: * @param name the method's name.
095: * @param desc the method's descriptor (see {@link Type Type}).
096: * @param exceptions the internal names of the method's exception
097: * classes (see {@link Type#getInternalName getInternalName}). May be
098: * <tt>null</tt>.
099: * @return an object to visit the byte code of the method, or <tt>null</tt> if
100: * this class visitor is not interested in visiting the code of this
101: * method.
102: */
103:
104: CodeVisitor visitMethod(int access, String name, String desc,
105: String[] exceptions);
106:
107: /**
108: * Visits the end of the class. This method, which is the last one to be
109: * called, is used to inform the visitor that all the fields and methods of
110: * the class have been visited.
111: */
112:
113: void visitEnd();
114: }
|