File	Doc	Category	Size	Date	Package
ClassFile.java	API Doc	J2ME CLDC 1.1	19321	Wed Feb 05 15:56:04 GMT 2003	kdp.classparser

ClassFile

• java.lang.Object

Fields Summary
private static final int	OBJECT_SUPER_CLASS_ID Numeric ID of java.lang.Object's super class
final byte	TYPE_TAG_ARRAY Tag type from VMConstants.java
private String	baseName base name of class
private String	className className of this class
private String	classSignature name of the class file this represents
private FileReference	classFile signature of this class name
private int	magic identifies class file format, always 0xCAFEBABE
private int	majorVersion version number of the class file
private int	minorVersion
private int	constantPoolCount number of items in the constant pool
private ConstantPoolInfo[]	constantPool array of items in the constant pool
private AccessFlags	accessFlags access flags of this class
private int	thisClass name of this class
private int	superClass name of super class
private int	interfacesCount number of interfaces this class implements
private int[]	interfaces array of indices into the constant pool table that contain the names of the interfaces this class implements
private int	fieldsCount number of fields of this class
private FieldInfo[]	fieldInfo array of FieldInfo objects containing information about all the fields of this class
private int	methodsCount number of methods of this class
private MethodInfo[]	methodInfo array of MethodInfo objects containing information about all the methods of this class
private int	attributesCount number of attributes of this class
private AttributeInfo[]	attributes attributes of this class
private byte	typeTag JDWP type type tag
int	classID the class ID of this class as told to us by the KVM itself
int	classStatus

Constructors Summary

public ClassFile(FileReference classFile, String className, byte typeTag) Constructor. param classFile reference to the class file this object will represent int index; this.classFile = classFile; this.className = className; if ((index = className.lastIndexOf('/")) != -1) this.baseName = className.substring(index+1); else this.baseName = className; this.typeTag = typeTag; if (typeTag == TYPE_TAG_ARRAY) { /* restore the className which already includes its signature */ classSignature = className; } else { /* Make up the signature for this class * Add 'L' at the beginning, and the ';' at the end. */ classSignature = "L" + className.replace('.", '/") + ";"; }

Methods Summary
public boolean	equals(java.lang.String newclassName) return className.equals(newclassName);
public java.util.List	getAllFieldInfo() Returns a list of FieldInfo objects Vector vector = new Vector(); for ( int i=0; i < fieldInfo.length; i++ ) vector.add( fieldInfo[ i ] ); return vector;
public java.util.List	getAllInterfaces() Returns a list of class names that are interfaces implemented by this class Vector vector = new Vector(); int nameIndex; ConstantUtf8Info utf8Info; for ( int i=0; i < interfacesCount; i++ ) { nameIndex = ((ConstantClassInfo)constantPool[interfaces[ i ]]).getNameIndex(); utf8Info = (ConstantUtf8Info)constantPool[nameIndex]; Log.LOGN(3, "interface: " + utf8Info.toString()); vector.add(utf8Info.toString()); } return vector;
public java.util.List	getAllMethodInfo() Returns a list of MethodInfo objects Vector vector = new Vector(); for ( int i=0; i < methodInfo.length; i++ ) vector.add( methodInfo[ i ] ); return vector;
public java.lang.String	getBaseName() return baseName;
public java.lang.String	getClassFileName() Returns the class filename return (classFile.toString());
public int	getClassID() return (classID);
public java.lang.String	getClassName() return className;
public java.lang.String	getClassSignature() return classSignature;
public int	getClassStatus() return (classStatus);
public byte	getJDWPTypeTag() return typeTag;
public MethodInfo	getMethodInfoByIndex(int methodIndex) Get a methodinfo given a method index if (methodIndex > methodInfo.length) return null; else return methodInfo[methodIndex];
public MethodInfo	getMethodInfoByName(java.lang.String methodName, java.lang.String sig) Get a methodinfo given a method name for (int i = 0; i < methodsCount; i++) { if ( methodInfo[i].getName().equals(methodName) && methodInfo[i].getSignatureRaw().equals( sig ) ) return methodInfo[i]; } return null;
public int	getRawAccessFlags() return (accessFlags.getRawAccessFlags());
public SourceFileAttribute	getSourceAttribute() Retrieves the Sourcefile attribute for this method. return SourceFileAttribute this methods code attribute or null if it does not have one int attrIndex = 0; boolean found = false; //loop through the attributes until the Source attribute is found or //there are no attributes left while ((!found) && (attrIndex < attributesCount)) { if (attributes[attrIndex].getType () == AttributeInfo.ATTR_SOURCEFILE) found = true; else ++attrIndex; } if (found) {//found the SourceFile attribute so return it AttributeInfo attrInfo = attributes[attrIndex]; return (SourceFileAttribute) attrInfo.getInfo (); } else return null; //didn't find it... just return null
public java.lang.String	getSuperClass() if (superClass == OBJECT_SUPER_CLASS_ID) return (""); else { ConstantClassInfo c = (ConstantClassInfo) constantPool[superClass]; int nameIndex = c.getNameIndex (); ConstantUtf8Info utf8Info = (ConstantUtf8Info) constantPool[nameIndex]; return utf8Info.toString(); }
public java.util.List	getVariableTableForMethodIndex(int methodIndex) MethodInfo mi = null; int i = 0; int attributeCount = 0; List list = null; if( (mi = getMethodInfoByIndex(methodIndex)) != null ){ list = mi.getLocalVariables(); // DEBUG // if (list != null) { // for( i = 0; i < list.size();i++) // ((LocalVariable)list.get(i)).print(); // } // END DEBUG } return list;
public MethodInfo	lookUpMethodByLineNumber(int lineNumber) Finds the method that contains the line in the source file with the specified line number. param int a source file line number return MethodInfo if a method contained code at the specified line number then the method's MethodInfo is returned otherwise null boolean found = false; int index = 0; //loop through all the methods until we find it or run out of methods while ((!found) && (index < methodsCount)) { if (methodInfo[index].containsLine (lineNumber)) found = true; else ++index; } return (found) ? methodInfo[index] : null;
public void	print(java.io.PrintStream out) Print the contents of this class file in a nice easy to read manner to the specified PrintStream param out where to output the contents of the class file ConstantClassInfo c; int nameIndex; ConstantUtf8Info utf8Info; //output the access flags out.println (accessFlags); //get the name of this class out of the constant pool table //and output it c = (ConstantClassInfo) constantPool[thisClass]; nameIndex = c.getNameIndex (); utf8Info = (ConstantUtf8Info) constantPool[nameIndex]; out.println ("This Class:\t\t" + StringParser.parseClassName (utf8Info.toString ())); //get the name of the super class out of the constant pool //table and output it String sc = getSuperClass(); out.print("Superclass: "); if (sc.equals("")) out.println("None"); else out.println(sc); //if this class implements any interfaces look them up in //the constant pool table and output them if (interfacesCount > 0) for (int lcv = 0; lcv < interfacesCount; ++lcv) { c = (ConstantClassInfo) constantPool[interfaces[lcv]]; nameIndex = c.getNameIndex (); utf8Info = (ConstantUtf8Info) constantPool[nameIndex]; out.println ("Interfaces:\t\t" + StringParser.parseClassName (utf8Info.toString ())); } //output the fields of this class file for (int lcv = 0; lcv < fieldsCount; ++lcv) out.println (fieldInfo[lcv].toString ()); //output the methods of this class file for (int lcv = 0; lcv < methodsCount; ++lcv) out.println (methodInfo[lcv].toString ()); //output the attributes of this class file for (int lcv = 0; lcv < attributesCount; ++lcv) out.println (attributes[lcv].toString ());
private int	readAttributes(java.io.DataInputStream iStream) Read in the attributes of this class. param iStream the stream on which to read data return int the number of attributes of this class exception IOException just pass any IOExceptions up //read in the number of attributes attributesCount = iStream.readUnsignedShort (); //allocate space for the attributes and read them in attributes = new AttributeInfo[attributesCount]; for (int lcv=0; lcv < attributesCount; ++lcv) attributes[lcv] = new AttributeInfo (iStream, constantPool); return attributesCount;
public void	readClassFile() Reads a Java class file from the filename passed to the constructor. DataInputStream iStream; try { //create the data input stream and start reading in the //class file iStream = new DataInputStream (classFile.getInputStream()); magic = iStream.readInt (); minorVersion = iStream.readUnsignedShort (); majorVersion = iStream.readUnsignedShort (); readConstantPool (iStream); accessFlags = new AccessFlags (iStream); thisClass = iStream.readUnsignedShort (); superClass = iStream.readUnsignedShort (); readInterfaces (iStream); readFieldInfo (iStream); readMethodInfo (iStream); readAttributes (iStream); iStream.close (); } catch (IOException e) {//something bad happened with the IO. System.out.println ("Caught IO Exception - " + e.getMessage ()); throw(e); }
private int	readConstantPool(java.io.DataInputStream iStream) Reads in the constant pool from a Java class file. param iStream the stream on which to read data return int the number of items in the constant pool exception IOException just pass any IOExceptions up //read the number of items in the constant pool constantPoolCount = iStream.readUnsignedShort (); //allocate space for the constant pool constantPool = new ConstantPoolInfo[constantPoolCount]; //read in all the items of the constant pool for (int lcv=1; lcv < constantPoolCount; ++lcv) { //the tag identifies what type of constant pool item //this is so read it in, then branch and create the //appropriate object byte tag = iStream.readByte (); switch (tag) { case ConstantPoolInfo.CONSTANT_Class : constantPool[lcv] = new ConstantClassInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Fieldref : constantPool[lcv] = new ConstantFieldrefInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Methodref : constantPool[lcv] = new ConstantMethodrefInfo (iStream); break; case ConstantPoolInfo.CONSTANT_InterfaceMethodref : constantPool[lcv] = new ConstantInterfaceMethodrefInfo (iStream); break; case ConstantPoolInfo.CONSTANT_String : constantPool[lcv] = new ConstantStringInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Integer : constantPool[lcv] = new ConstantIntegerInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Float : constantPool[lcv] = new ConstantFloatInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Long : constantPool[lcv] = new ConstantLongInfo (iStream); ++lcv; //longs "take" two constant pool entries break; case ConstantPoolInfo.CONSTANT_Double : constantPool[lcv] = new ConstantDoubleInfo (iStream); ++lcv; //doubles "take" two constant pool entries break; case ConstantPoolInfo.CONSTANT_NameAndType : constantPool[lcv] = new ConstantNameAndTypeInfo (iStream); break; case ConstantPoolInfo.CONSTANT_Utf8 : constantPool[lcv] = new ConstantUtf8Info (iStream); break; default : break; } } return constantPoolCount;
private int	readFieldInfo(java.io.DataInputStream iStream) Read in the fields of this class. param iStream the stream on which to read data return int the number of fields in this class exception IOException just pass any IOExceptions up //read in the number of fields fieldsCount = iStream.readUnsignedShort (); //allocate space for the fields and read them in fieldInfo = new FieldInfo[fieldsCount]; for (int lcv=0; lcv < fieldsCount; ++lcv) fieldInfo[lcv] = new FieldInfo (iStream, constantPool); return fieldsCount;
private int	readInterfaces(java.io.DataInputStream iStream) Read in the interfaces from the class file. param iStream the stream on which to read data return int the number of interfaces implemented by this class exception IOException just pass any IOExceptions up interfacesCount = iStream.readUnsignedShort (); //if there are no interfaces just return if (interfacesCount == 0) return interfacesCount; //allocate space for the interfaces and read them in interfaces = new int[interfacesCount]; for (int lcv=0; lcv < interfacesCount; ++lcv) interfaces[lcv] = iStream.readUnsignedShort (); return interfacesCount;
private int	readMethodInfo(java.io.DataInputStream iStream) Read in the methods of this class. param iStream the stream on which to read data return int the number of methods in this class exception IOException just pass any IOExceptions up //read in the number of methods methodsCount = iStream.readUnsignedShort (); //allocate space for the methods and read them in methodInfo = new MethodInfo[methodsCount]; for (int lcv=0; lcv < methodsCount; ++lcv) methodInfo[lcv] = new MethodInfo (iStream, constantPool); return methodsCount;
public void	setClassID(int classID) this.classID = classID;
public void	setClassStatus(int status) this.classStatus = status;