org.apache.bcel.classfile
Class JavaClass

java.lang.Object
  extended by org.apache.bcel.classfile.AccessFlags
      extended by org.apache.bcel.classfile.JavaClass
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, Node

public class JavaClass
extends AccessFlags
implements java.lang.Cloneable, Node, java.lang.Comparable

Represents a Java class, i.e., the data structures, constant pool, fields, methods and commands contained in a Java .class file. See JVM specification for details. The intent of this class is to represent a parsed or otherwise existing class file. Those interested in programatically generating classes should see the ClassGen class.

Version:
$Id: JavaClass.java 386056 2006-03-15 11:31:56Z tcurdt $
Author:
M. Dahm
See Also:
ClassGen, Serialized Form

Field Summary
private static BCELComparator _cmp
           
private  Attribute[] attributes
           
private  java.lang.String class_name
           
private  int class_name_index
           
private  ConstantPool constant_pool
           
(package private) static boolean debug
           
private  Field[] fields
           
static byte FILE
           
private  java.lang.String file_name
           
static byte HEAP
           
private  java.lang.String[] interface_names
           
private  int[] interfaces
           
private  int major
           
private  Method[] methods
           
private  int minor
           
private  java.lang.String package_name
           
private  Repository repository
          In cases where we go ahead and create something, use the default SyntheticRepository, because we don't know any better.
(package private) static char sep
           
private  byte source
           
private  java.lang.String source_file_name
           
private  java.lang.String superclass_name
           
private  int superclass_name_index
           
static byte ZIP
           
 
Fields inherited from class org.apache.bcel.classfile.AccessFlags
access_flags
 
Constructor Summary
JavaClass(int class_name_index, int superclass_name_index, java.lang.String file_name, int major, int minor, int access_flags, ConstantPool constant_pool, int[] interfaces, Field[] fields, Method[] methods, Attribute[] attributes)
          Constructor gets all contents as arguments.
JavaClass(int class_name_index, int superclass_name_index, java.lang.String file_name, int major, int minor, int access_flags, ConstantPool constant_pool, int[] interfaces, Field[] fields, Method[] methods, Attribute[] attributes, byte source)
          Constructor gets all contents as arguments.
 
Method Summary
 void accept(Visitor v)
          Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class.
 int compareTo(java.lang.Object obj)
          Return the natural ordering of two JavaClasses.
 JavaClass copy()
           
(package private) static void Debug(java.lang.String str)
           
 void dump(java.io.DataOutputStream file)
          Dump Java class to output stream in binary format.
 void dump(java.io.File file)
          Dump class to a file.
 void dump(java.io.OutputStream file)
          Dump Java class to output stream in binary format.
 void dump(java.lang.String _file_name)
          Dump class to a file named file_name.
 boolean equals(java.lang.Object obj)
          Return value as defined by given BCELComparator strategy.
 JavaClass[] getAllInterfaces()
          Get all interfaces implemented by this JavaClass (transitively).
 Attribute[] getAttributes()
           
 byte[] getBytes()
           
 java.lang.String getClassName()
           
 int getClassNameIndex()
           
static BCELComparator getComparator()
           
 ConstantPool getConstantPool()
           
 Field[] getFields()
           
 java.lang.String getFileName()
           
 int[] getInterfaceIndices()
           
 java.lang.String[] getInterfaceNames()
           
 JavaClass[] getInterfaces()
          Get interfaces directly implemented by this JavaClass.
 int getMajor()
           
 Method getMethod(java.lang.reflect.Method m)
           
 Method[] getMethods()
           
 int getMinor()
           
 java.lang.String getPackageName()
           
 Repository getRepository()
          Gets the ClassRepository which holds its definition.
 byte getSource()
           
 java.lang.String getSourceFileName()
           
 JavaClass getSuperClass()
           
 JavaClass[] getSuperClasses()
           
 java.lang.String getSuperclassName()
           
 int getSuperclassNameIndex()
           
 int hashCode()
          Return value as defined by given BCELComparator strategy.
 boolean implementationOf(JavaClass inter)
           
private static java.lang.String indent(java.lang.Object obj)
           
 boolean instanceOf(JavaClass super_class)
          Equivalent to runtime "instanceof" operator.
 boolean isClass()
           
 boolean isSuper()
           
 void setAttributes(Attribute[] attributes)
           
 void setClassName(java.lang.String class_name)
           
 void setClassNameIndex(int class_name_index)
           
static void setComparator(BCELComparator comparator)
           
 void setConstantPool(ConstantPool constant_pool)
           
 void setFields(Field[] fields)
           
 void setFileName(java.lang.String file_name)
          Set File name of class, aka SourceFile attribute value
 void setInterfaceNames(java.lang.String[] interface_names)
           
 void setInterfaces(int[] interfaces)
           
 void setMajor(int major)
           
 void setMethods(Method[] methods)
           
 void setMinor(int minor)
           
 void setRepository(Repository repository)
          Sets the ClassRepository which loaded the JavaClass.
 void setSourceFileName(java.lang.String source_file_name)
          Set absolute path to file this class was read from.
 void setSuperclassName(java.lang.String superclass_name)
           
 void setSuperclassNameIndex(int superclass_name_index)
           
 java.lang.String toString()
           
 
Methods inherited from class org.apache.bcel.classfile.AccessFlags
getAccessFlags, getModifiers, isAbstract, isAbstract, isAnnotation, isAnnotation, isEnum, isEnum, isFinal, isFinal, isInterface, isInterface, isNative, isNative, isPrivate, isPrivate, isProtected, isProtected, isPublic, isPublic, isStatic, isStatic, isStrictfp, isStrictfp, isSynchronized, isSynchronized, isSynthetic, isSynthetic, isTransient, isTransient, isVolatile, isVolatile, setAccessFlags, setModifiers
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

file_name

private java.lang.String file_name

package_name

private java.lang.String package_name

source_file_name

private java.lang.String source_file_name

class_name_index

private int class_name_index

superclass_name_index

private int superclass_name_index

class_name

private java.lang.String class_name

superclass_name

private java.lang.String superclass_name

major

private int major

minor

private int minor

constant_pool

private ConstantPool constant_pool

interfaces

private int[] interfaces

interface_names

private java.lang.String[] interface_names

fields

private Field[] fields

methods

private Method[] methods

attributes

private Attribute[] attributes

source

private byte source

HEAP

public static final byte HEAP
See Also:
Constant Field Values

FILE

public static final byte FILE
See Also:
Constant Field Values

ZIP

public static final byte ZIP
See Also:
Constant Field Values

debug

static boolean debug

sep

static char sep

_cmp

private static BCELComparator _cmp

repository

private transient Repository repository
In cases where we go ahead and create something, use the default SyntheticRepository, because we don't know any better.

Constructor Detail

JavaClass

public JavaClass(int class_name_index,
                 int superclass_name_index,
                 java.lang.String file_name,
                 int major,
                 int minor,
                 int access_flags,
                 ConstantPool constant_pool,
                 int[] interfaces,
                 Field[] fields,
                 Method[] methods,
                 Attribute[] attributes,
                 byte source)
Constructor gets all contents as arguments.

Parameters:
class_name_index - Index into constant pool referencing a ConstantClass that represents this class.
superclass_name_index - Index into constant pool referencing a ConstantClass that represents this class's superclass.
file_name - File name
major - Major compiler version
minor - Minor compiler version
access_flags - Access rights defined by bit flags
constant_pool - Array of constants
interfaces - Implemented interfaces
fields - Class fields
methods - Class methods
attributes - Class attributes
source - Read from file or generated in memory?

JavaClass

public JavaClass(int class_name_index,
                 int superclass_name_index,
                 java.lang.String file_name,
                 int major,
                 int minor,
                 int access_flags,
                 ConstantPool constant_pool,
                 int[] interfaces,
                 Field[] fields,
                 Method[] methods,
                 Attribute[] attributes)
Constructor gets all contents as arguments.

Parameters:
class_name_index - Class name
superclass_name_index - Superclass name
file_name - File name
major - Major compiler version
minor - Minor compiler version
access_flags - Access rights defined by bit flags
constant_pool - Array of constants
interfaces - Implemented interfaces
fields - Class fields
methods - Class methods
attributes - Class attributes
Method Detail

accept

public void accept(Visitor v)
Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

Specified by:
accept in interface Node
Parameters:
v - Visitor object

Debug

static final void Debug(java.lang.String str)

dump

public void dump(java.io.File file)
          throws java.io.IOException
Dump class to a file.

Parameters:
file - Output file
Throws:
java.io.IOException

dump

public void dump(java.lang.String _file_name)
          throws java.io.IOException
Dump class to a file named file_name.

Parameters:
_file_name - Output file name
Throws:
java.io.IOException

getBytes

public byte[] getBytes()
Returns:
class in binary format

dump

public void dump(java.io.OutputStream file)
          throws java.io.IOException
Dump Java class to output stream in binary format.

Parameters:
file - Output stream
Throws:
java.io.IOException

dump

public void dump(java.io.DataOutputStream file)
          throws java.io.IOException
Dump Java class to output stream in binary format.

Parameters:
file - Output stream
Throws:
java.io.IOException

getAttributes

public Attribute[] getAttributes()
Returns:
Attributes of the class.

getClassName

public java.lang.String getClassName()
Returns:
Class name.

getPackageName

public java.lang.String getPackageName()
Returns:
Package name.

getClassNameIndex

public int getClassNameIndex()
Returns:
Class name index.

getConstantPool

public ConstantPool getConstantPool()
Returns:
Constant pool.

getFields

public Field[] getFields()
Returns:
Fields, i.e., variables of the class. Like the JVM spec mandates for the classfile format, these fields are those specific to this class, and not those of the superclass or superinterfaces.

getFileName

public java.lang.String getFileName()
Returns:
File name of class, aka SourceFile attribute value

getInterfaceNames

public java.lang.String[] getInterfaceNames()
Returns:
Names of implemented interfaces.

getInterfaceIndices

public int[] getInterfaceIndices()
Returns:
Indices in constant pool of implemented interfaces.

getMajor

public int getMajor()
Returns:
Major number of class file version.

getMethods

public Method[] getMethods()
Returns:
Methods of the class.

getMethod

public Method getMethod(java.lang.reflect.Method m)
Returns:
A org.apache.bcel.classfile.Method corresponding to java.lang.reflect.Method if any

getMinor

public int getMinor()
Returns:
Minor number of class file version.

getSourceFileName

public java.lang.String getSourceFileName()
Returns:
sbsolute path to file where this class was read from

getSuperclassName

public java.lang.String getSuperclassName()
Returns:
Superclass name.

getSuperclassNameIndex

public int getSuperclassNameIndex()
Returns:
Class name index.

setAttributes

public void setAttributes(Attribute[] attributes)
Parameters:
attributes - .

setClassName

public void setClassName(java.lang.String class_name)
Parameters:
class_name - .

setClassNameIndex

public void setClassNameIndex(int class_name_index)
Parameters:
class_name_index - .

setConstantPool

public void setConstantPool(ConstantPool constant_pool)
Parameters:
constant_pool - .

setFields

public void setFields(Field[] fields)
Parameters:
fields - .

setFileName

public void setFileName(java.lang.String file_name)
Set File name of class, aka SourceFile attribute value


setInterfaceNames

public void setInterfaceNames(java.lang.String[] interface_names)
Parameters:
interface_names - .

setInterfaces

public void setInterfaces(int[] interfaces)
Parameters:
interfaces - .

setMajor

public void setMajor(int major)
Parameters:
major - .

setMethods

public void setMethods(Method[] methods)
Parameters:
methods - .

setMinor

public void setMinor(int minor)
Parameters:
minor - .

setSourceFileName

public void setSourceFileName(java.lang.String source_file_name)
Set absolute path to file this class was read from.


setSuperclassName

public void setSuperclassName(java.lang.String superclass_name)
Parameters:
superclass_name - .

setSuperclassNameIndex

public void setSuperclassNameIndex(int superclass_name_index)
Parameters:
superclass_name_index - .

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
String representing class contents.

indent

private static final java.lang.String indent(java.lang.Object obj)

copy

public JavaClass copy()
Returns:
deep copy of this class

isSuper

public final boolean isSuper()

isClass

public final boolean isClass()

getSource

public final byte getSource()
Returns:
returns either HEAP (generated), FILE, or ZIP

getRepository

public Repository getRepository()
Gets the ClassRepository which holds its definition. By default this is the same as SyntheticRepository.getInstance();


setRepository

public void setRepository(Repository repository)
Sets the ClassRepository which loaded the JavaClass. Should be called immediately after parsing is done.


instanceOf

public final boolean instanceOf(JavaClass super_class)
                         throws java.lang.ClassNotFoundException
Equivalent to runtime "instanceof" operator.

Returns:
true if this JavaClass is derived from the super class
Throws:
java.lang.ClassNotFoundException - if superclasses or superinterfaces of this object can't be found

implementationOf

public boolean implementationOf(JavaClass inter)
                         throws java.lang.ClassNotFoundException
Returns:
true, if this class is an implementation of interface inter
Throws:
java.lang.ClassNotFoundException - if superclasses or superinterfaces of this class can't be found

getSuperClass

public JavaClass getSuperClass()
                        throws java.lang.ClassNotFoundException
Returns:
the superclass for this JavaClass object, or null if this is java.lang.Object
Throws:
java.lang.ClassNotFoundException - if the superclass can't be found

getSuperClasses

public JavaClass[] getSuperClasses()
                            throws java.lang.ClassNotFoundException
Returns:
list of super classes of this class in ascending order, i.e., java.lang.Object is always the last element
Throws:
java.lang.ClassNotFoundException - if any of the superclasses can't be found

getInterfaces

public JavaClass[] getInterfaces()
                          throws java.lang.ClassNotFoundException
Get interfaces directly implemented by this JavaClass.

Throws:
java.lang.ClassNotFoundException

getAllInterfaces

public JavaClass[] getAllInterfaces()
                             throws java.lang.ClassNotFoundException
Get all interfaces implemented by this JavaClass (transitively).

Throws:
java.lang.ClassNotFoundException

getComparator

public static BCELComparator getComparator()
Returns:
Comparison strategy object

setComparator

public static void setComparator(BCELComparator comparator)
Parameters:
comparator - Comparison strategy object

equals

public boolean equals(java.lang.Object obj)
Return value as defined by given BCELComparator strategy. By default two JavaClass objects are said to be equal when their class names are equal.

Overrides:
equals in class java.lang.Object
See Also:
Object.equals(java.lang.Object)

compareTo

public int compareTo(java.lang.Object obj)
Return the natural ordering of two JavaClasses. This ordering is based on the class name

Specified by:
compareTo in interface java.lang.Comparable

hashCode

public int hashCode()
Return value as defined by given BCELComparator strategy. By default return the hashcode of the class name.

Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()