Apache Commons BCEL 6.8.2 · org.apache.bcel.classfile.JavaClass

Field Summary

Modifier and Type	Field and Description
private AnnotationEntry[]	annotations
private Attribute[]	attributes
private static BCELComparator<JavaClass>	bcelComparator
private String	className
private int	classNameIndex
private boolean	computedNestedTypeStatus
private ConstantPool	constantPool
private static final boolean	debug
public static final JavaClass[]	EMPTY_ARRAY Empty array.
public static final String	EXTENSION The standard class file extension.
private Field[]	fields
public static final byte	FILE
private String	fileName
public static final byte	HEAP
private String[]	interfaceNames
private int[]	interfaces
private boolean	isAnonymous
private boolean	isNested
private int	major
private Method[]	methods
private int	minor
private final String	packageName
private transient Repository	repository In cases where we go ahead and create something, use the default SyntheticRepository, because we don't know any better.
private byte	source
private String	sourceFileName
private String	superclassName
private int	superclassNameIndex
public static final byte	ZIP

Inherited from org.apache.bcel.classfile.AccessFlags:: access_flags

Constructor Summary

Access	Constructor and Description
public	JavaClass(final int Class name classNameIndex, final int Superclass name superclassNameIndex, final String File name fileName, final int Major compiler version major, final int Minor compiler version minor, final int Access rights defined by bit flags accessFlags, final ConstantPool Array of constants constantPool, final int[] Implemented interfaces interfaces, final Field[] Class fields fields, final Method[] Class methods methods, final Attribute[] Class attributes attributes) Constructor gets all contents as arguments.
public	JavaClass(final int Index into constant pool referencing a ConstantClass that represents this class. classNameIndex, final int Index into constant pool referencing a ConstantClass that represents this class's superclass. superclassNameIndex, final String File name fileName, final int Major compiler version major, final int Minor compiler version minor, final int Access rights defined by bit flags accessFlags, final ConstantPool Array of constants constantPool, int[] Implemented interfaces interfaces, Field[] Class fields fields, Method[] Class methods methods, Attribute[] Class attributes attributes, final byte Read from file or generated in memory? source) Constructor gets all contents as arguments.

Access

Constructor and Description

public

JavaClass(final int

Class name

classNameIndex, final int

Superclass name

superclassNameIndex, final String

File name

fileName, final int

Major compiler version

major, final int

Minor compiler version

minor, final int

Access rights defined by bit flags

accessFlags, final ConstantPool

Array of constants

constantPool, final int[]

Implemented interfaces

interfaces, final Field[]

Class fields

fields, final Method[]

Class methods

methods, final Attribute[]

Class attributes

attributes)

Constructor gets all contents as arguments.

public

JavaClass(final int

Index into constant pool referencing a ConstantClass that represents this class.

classNameIndex, final int

Index into constant pool referencing a ConstantClass that represents this class's superclass.

superclassNameIndex, final String

File name

fileName, final int

Major compiler version

major, final int

Minor compiler version

minor, final int

Access rights defined by bit flags

accessFlags, final ConstantPool

Array of constants

constantPool, int[]

Implemented interfaces

interfaces, Field[]

Class fields

fields, Method[]

Class methods

methods, Attribute[]

Class attributes

attributes, final byte

Read from file or generated in memory?

source)

Constructor gets all contents as arguments.

Method Summary

Modifier and Type	Method and Description
public void	accept(final Visitor Visitor object v) Implements org.apache.bcel.classfile.Node.accept. Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
public int	compareTo(final JavaClass the object to be compared. obj) Implements java.lang.Comparable.compareTo. Return the natural ordering of two JavaClasses.
private void	computeNestedTypeStatus()
public JavaClass	Returns: deep copy of this class copy()
pack-priv static void	Debug(final String str)
public void	dump(final DataOutputStream Output stream file) Dump Java class to output stream in binary format.
public void	dump(final File Output file file) Dump class to a file.
public void	dump(final OutputStream Output stream file) Dump Java class to output stream in binary format.
public void	dump(final String Output file name fileName) Dump class to a file named fileName.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Return value as defined by given BCELComparator strategy.
public Field	Returns: field matching given name and type, null if field is not found or not accessible from this class. findField(final String the field name to find fieldName, final Type the field type to find fieldType) Finds a visible field by name and type in this class and its super classes.
public JavaClass[]	getAllInterfaces() Gets all interfaces implemented by this JavaClass (transitively).
public AnnotationEntry[]	Returns: Annotations on the class getAnnotationEntries()
public Attribute[]	Returns: Attributes of the class. getAttributes()
public byte[]	Returns: class in binary format getBytes()
public String	Returns: Class name. getClassName()
public int	Returns: Class name index. getClassNameIndex()
public static BCELComparator<JavaClass>	Returns: Comparison strategy object. getComparator()
public ConstantPool	Returns: Constant pool. getConstantPool()
public Field[]	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. getFields()
public String	Returns: File name of class, aka SourceFile attribute value getFileName()
public int[]	Returns: Indices in constant pool of implemented interfaces. getInterfaceIndices()
public String[]	Returns: Names of implemented interfaces. getInterfaceNames()
public JavaClass[]	getInterfaces() Gets interfaces directly implemented by this JavaClass.
public int	Returns: Major number of class file version. getMajor()
public Method	Returns: A `Method` corresponding to java.lang.reflect.Method if any getMethod(final Method m)
public Method[]	Returns: Methods of the class. getMethods()
public int	Returns: Minor number of class file version. getMinor()
public String	Returns: Package name. getPackageName()
public Repository	getRepository() Gets the ClassRepository which holds its definition.
public final byte	Returns: returns either HEAP (generated), FILE, or ZIP getSource()
public String	Returns: file name where this class was read from getSourceFileName()
public String	Returns: path to original source file of parsed class, relative to original source directory. getSourceFilePath() Gets the source file path including the package path.
public JavaClass	Returns: the superclass for this JavaClass object, or null if this is `Object` getSuperClass()
public JavaClass[]	Returns: list of super classes of this class in ascending order, i.e., java.lang.Object is always the last element getSuperClasses()
public String	Returns: Superclass name. getSuperclassName() returns the super class name of this class.
public int	Returns: Class name index. getSuperclassNameIndex()
public int	hashCode() Overrides java.lang.Object.hashCode. Return value as defined by given BCELComparator strategy.
public boolean	Returns: true, if this class is an implementation of interface inter implementationOf(final JavaClass inter)
private static String	indent(final Object obj)
public final boolean	Returns: true if this JavaClass is derived from the super class instanceOf(final JavaClass superclass) Equivalent to runtime "instanceof" operator.
public final boolean	isAnonymous()
public final boolean	isClass()
public final boolean	isNested()
public final boolean	isSuper()
public void	setAttributes(final Attribute[] . attributes)
public void	setClassName(final String . className)
public void	setClassNameIndex(final int . classNameIndex)
public static void	setComparator(final BCELComparator<JavaClass> Comparison strategy object. comparator)
public void	setConstantPool(final ConstantPool . constantPool)
public void	setFields(final Field[] . fields)
public void	setFileName(final String fileName) Sets File name of class, aka SourceFile attribute value
public void	setInterfaceNames(final String[] . interfaceNames)
public void	setInterfaces(final int[] . interfaces)
public void	setMajor(final int . major)
public void	setMethods(final Method[] . methods)
public void	setMinor(final int . minor)
public void	setRepository(final Repository repository) Sets the ClassRepository which loaded the JavaClass.
public void	setSourceFileName(final String sourceFileName) Sets absolute path to file this class was read from.
public void	setSuperclassName(final String . superclassName)
public void	setSuperclassNameIndex(final int . superclassNameIndex)
public String	Returns: String representing class contents. toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

annotations	back to summary
private AnnotationEntry[] annotations

attributes	back to summary
private Attribute[] attributes

bcelComparator	back to summary
private static BCELComparator<JavaClass> bcelComparator

className	back to summary
private String className

classNameIndex	back to summary
private int classNameIndex

computedNestedTypeStatus	back to summary
private boolean computedNestedTypeStatus

constantPool	back to summary
private ConstantPool constantPool

debug	back to summary
private static final boolean debug

EMPTY_ARRAY	back to summary
public static final JavaClass[] EMPTY_ARRAY Empty array. Since 6.6.0

EMPTY_ARRAY

back to summary

public static final JavaClass[] EMPTY_ARRAY

Empty array.

Since: 6.6.0

EXTENSION	back to summary
public static final String EXTENSION The standard class file extension. Since 6.7.0

EXTENSION

back to summary

public static final String EXTENSION

The standard class file extension.

Since: 6.7.0

fields	back to summary
private Field[] fields

FILE	back to summary
public static final byte FILE

fileName	back to summary
private String fileName

HEAP	back to summary
public static final byte HEAP

interfaceNames	back to summary
private String[] interfaceNames

interfaces	back to summary
private int[] interfaces

isAnonymous	back to summary
private boolean isAnonymous

isNested	back to summary
private boolean isNested

major	back to summary
private int major

methods	back to summary
private Method[] methods

minor	back to summary
private int minor

packageName	back to summary
private final String packageName

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

source	back to summary
private byte source

sourceFileName	back to summary
private String sourceFileName

superclassName	back to summary
private String superclassName

superclassNameIndex	back to summary
private int superclassNameIndex

ZIP	back to summary
public static final byte ZIP

Constructor Detail

JavaClass	back to summary
public JavaClass(final int classNameIndex, final int superclassNameIndex, final String fileName, final int major, final int minor, final int accessFlags, final ConstantPool constantPool, final int[] interfaces, final Field[] fields, final Method[] methods, final Attribute[] attributes) Constructor gets all contents as arguments. Parameters classNameIndex:int Class name superclassNameIndex:int Superclass name fileName:String File name major:int Major compiler version minor:int Minor compiler version accessFlags:int Access rights defined by bit flags constantPool:ConstantPool Array of constants interfaces:int[] Implemented interfaces fields:Field[] Class fields methods:Method[] Class methods attributes:Attribute[] Class attributes

JavaClass

back to summary

public JavaClass(final int classNameIndex, final int superclassNameIndex, final String fileName, final int major, final int minor, final int accessFlags, final ConstantPool constantPool, final int[] interfaces, final Field[] fields, final Method[] methods, final Attribute[] attributes)

Constructor gets all contents as arguments.

Parameters

classNameIndex:int: Class name
superclassNameIndex:int: Superclass name
fileName:String: File name
major:int: Major compiler version
minor:int: Minor compiler version
accessFlags:int: Access rights defined by bit flags
constantPool:ConstantPool: Array of constants
interfaces:int[]: Implemented interfaces
fields:Field[]: Class fields
methods:Method[]: Class methods
attributes:Attribute[]: Class attributes

JavaClass	back to summary
public JavaClass(final int classNameIndex, final int superclassNameIndex, final String fileName, final int major, final int minor, final int accessFlags, final ConstantPool constantPool, int[] interfaces, Field[] fields, Method[] methods, Attribute[] attributes, final byte source) Constructor gets all contents as arguments. Parameters classNameIndex:int Index into constant pool referencing a ConstantClass that represents this class. superclassNameIndex:int Index into constant pool referencing a ConstantClass that represents this class's superclass. fileName:String File name major:int Major compiler version minor:int Minor compiler version accessFlags:int Access rights defined by bit flags constantPool:ConstantPool Array of constants interfaces:int[] Implemented interfaces fields:Field[] Class fields methods:Method[] Class methods attributes:Attribute[] Class attributes source:byte Read from file or generated in memory?

JavaClass

back to summary

public JavaClass(final int classNameIndex, final int superclassNameIndex, final String fileName, final int major, final int minor, final int accessFlags, final ConstantPool constantPool, int[] interfaces, Field[] fields, Method[] methods, Attribute[] attributes, final byte source)

Constructor gets all contents as arguments.

Parameters

classNameIndex:int: Index into constant pool referencing a ConstantClass that represents this class.
superclassNameIndex:int: Index into constant pool referencing a ConstantClass that represents this class's superclass.
fileName:String: File name
major:int: Major compiler version
minor:int: Minor compiler version
accessFlags:int: Access rights defined by bit flags
constantPool:ConstantPool: Array of constants
interfaces:int[]: Implemented interfaces
fields:Field[]: Class fields
methods:Method[]: Class methods
attributes:Attribute[]: Class attributes
source:byte: Read from file or generated in memory?

Method Detail

accept	back to summary
public void accept(final Visitor v) Implements org.apache.bcel.classfile.Node.accept. Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects. Parameters v:Visitor Visitor object Annotations @Override

back to summary

public void accept(final Visitor v)

Implements org.apache.bcel.classfile.Node.accept.

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

Parameters

v:Visitor: Visitor object

Annotations

@Override

compareTo	back to summary
public int compareTo(final JavaClass obj) Implements java.lang.Comparable.compareTo. Return the natural ordering of two JavaClasses. This ordering is based on the class name Parameters obj:JavaClass Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override Since 6.0

compareTo

back to summary

public int compareTo(final JavaClass obj)

Implements java.lang.Comparable.compareTo.

Return the natural ordering of two JavaClasses. This ordering is based on the class name

Parameters

obj:JavaClass

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

Since

6.0

computeNestedTypeStatus	back to summary
private void computeNestedTypeStatus()

copy	back to summary
public JavaClass copy() Returns:JavaClass deep copy of this class

Debug	back to summary
pack-priv static void Debug(final String str)

dump	back to summary
public void dump(final DataOutputStream file) throws IOException Dump Java class to output stream in binary format. Parameters file:DataOutputStream Output stream Exceptions IOException: if an I/O error occurs.

dump

back to summary

public void dump(final DataOutputStream file) throws IOException

Dump Java class to output stream in binary format.

Parameters

file:DataOutputStream: Output stream

Exceptions

IOException:: if an I/O error occurs.

dump	back to summary
public void dump(final File file) throws IOException Dump class to a file. Parameters file:File Output file Exceptions IOException: if an I/O error occurs.

dump

back to summary

public void dump(final File file) throws IOException

Dump class to a file.

Parameters

file:File: Output file

Exceptions

IOException:: if an I/O error occurs.

dump	back to summary
public void dump(final OutputStream file) throws IOException Dump Java class to output stream in binary format. Parameters file:OutputStream Output stream Exceptions IOException: if an I/O error occurs.

dump

back to summary

public void dump(final OutputStream file) throws IOException

Dump Java class to output stream in binary format.

Parameters

file:OutputStream: Output stream

Exceptions

IOException:: if an I/O error occurs.

dump	back to summary
public void dump(final String fileName) throws IOException Dump class to a file named fileName. Parameters fileName:String Output file name Exceptions IOException: if an I/O error occurs.

dump

back to summary

public void dump(final String fileName) throws IOException

Dump class to a file named fileName.

Parameters

fileName:String: Output file name

Exceptions

IOException:: if an I/O error occurs.

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Return value as defined by given BCELComparator strategy. By default two JavaClass objects are said to be equal when their class names are equal. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override See Also `Object#equals(Object)`

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Return value as defined by given BCELComparator strategy. By default two JavaClass objects are said to be equal when their class names are equal.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

See Also

Object#equals(Object)

findField	back to summary
public Field findField(final String fieldName, final Type fieldType) throws ClassNotFoundException Finds a visible field by name and type in this class and its super classes. Parameters fieldName:String the field name to find fieldType:Type the field type to find Returns:Field field matching given name and type, null if field is not found or not accessible from this class. Since 6.8.0

findField

back to summary

public Field findField(final String fieldName, final Type fieldType) throws ClassNotFoundException

Finds a visible field by name and type in this class and its super classes.

Parameters

fieldName:String: the field name to find
fieldType:Type: the field type to find

Returns:Field

field matching given name and type, null if field is not found or not accessible from this class.

Since

6.8.0

getAllInterfaces	back to summary
public JavaClass[] getAllInterfaces() throws ClassNotFoundException Gets all interfaces implemented by this JavaClass (transitively). Exceptions ClassNotFoundException: if any of the class's superclasses or interfaces can't be found.

getAllInterfaces

back to summary

public JavaClass[] getAllInterfaces() throws ClassNotFoundException

Gets all interfaces implemented by this JavaClass (transitively).

Exceptions

ClassNotFoundException:: if any of the class's superclasses or interfaces can't be found.

getAnnotationEntries	back to summary
public AnnotationEntry[] getAnnotationEntries() Returns:AnnotationEntry[] Annotations on the class Since 6.0

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

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

getClassName	back to summary
public String getClassName() Returns:String Class name.

getClassNameIndex	back to summary
public int getClassNameIndex() Returns:int Class name index.

getComparator	back to summary
public static BCELComparator<JavaClass> getComparator() Returns:BCELComparator<JavaClass> Comparison strategy object.

getConstantPool	back to summary
public ConstantPool getConstantPool() Returns:ConstantPool Constant pool.

getFields	back to summary
public Field[] getFields() Returns:Field[] 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	back to summary
public String getFileName() Returns:String File name of class, aka SourceFile attribute value

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

getInterfaceNames	back to summary
public String[] getInterfaceNames() Returns:String[] Names of implemented interfaces.

getInterfaces

back to summary

public JavaClass[] getInterfaces() throws ClassNotFoundException

Gets interfaces directly implemented by this JavaClass.

Exceptions

ClassNotFoundException:: if any of the class's interfaces can't be found.

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

getMethod	back to summary
public Method getMethod(final Method m) Returns:Method A `Method` corresponding to java.lang.reflect.Method if any

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

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

getPackageName	back to summary
public String getPackageName() Returns:String Package name.

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

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

getSourceFileName	back to summary
public String getSourceFileName() Returns:String file name where this class was read from

getSourceFilePath

back to summary

public String getSourceFilePath()

Gets the source file path including the package path.

Returns:String: path to original source file of parsed class, relative to original source directory.
Since: 6.7.0

getSuperClass	back to summary
public JavaClass getSuperClass() throws ClassNotFoundException Returns:JavaClass the superclass for this JavaClass object, or null if this is `Object` Exceptions ClassNotFoundException: if the superclass can't be found

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

getSuperclassName back to summary

public String getSuperclassName()

returns the super class name of this class. In the case that this class is Object, it will return itself (Object). This is probably incorrect but isn't fixed at this time to not break existing clients.

Returns:String: Superclass name.

getSuperclassNameIndex	back to summary
public int getSuperclassNameIndex() Returns:int Class name index.

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Return value as defined by given BCELComparator strategy. By default return the hash code of the class name.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

See Also

Object#hashCode()

implementationOf	back to summary
public boolean implementationOf(final JavaClass inter) throws ClassNotFoundException Returns:boolean true, if this class is an implementation of interface inter Exceptions ClassNotFoundException: if superclasses or superinterfaces of this class can't be found

indent	back to summary
private static String indent(final Object obj)

instanceOf

back to summary

public final boolean instanceOf(final JavaClass superclass) throws ClassNotFoundException

Equivalent to runtime "instanceof" operator.

Returns:boolean

true if this JavaClass is derived from the super class

Exceptions

ClassNotFoundException:: if superclasses or superinterfaces of this object can't be found

isAnonymous	back to summary
public final boolean isAnonymous() Since 6.0

isClass	back to summary
public final boolean isClass()

isNested	back to summary
public final boolean isNested() Since 6.0

isSuper	back to summary
public final boolean isSuper()

setAttributes	back to summary
public void setAttributes(final Attribute[] attributes) Parameters attributes:Attribute[] .

setClassName	back to summary
public void setClassName(final String className) Parameters className:String .

setClassNameIndex	back to summary
public void setClassNameIndex(final int classNameIndex) Parameters classNameIndex:int .

setComparator	back to summary
public static void setComparator(final BCELComparator<JavaClass> comparator) Parameters comparator:BCELComparator<JavaClass> Comparison strategy object.

setConstantPool	back to summary
public void setConstantPool(final ConstantPool constantPool) Parameters constantPool:ConstantPool .

setFields	back to summary
public void setFields(final Field[] fields) Parameters fields:Field[] .

setFileName	back to summary
public void setFileName(final String fileName) Sets File name of class, aka SourceFile attribute value

setInterfaceNames	back to summary
public void setInterfaceNames(final String[] interfaceNames) Parameters interfaceNames:String[] .

setInterfaces	back to summary
public void setInterfaces(final int[] interfaces) Parameters interfaces:int[] .

setMajor	back to summary
public void setMajor(final int major) Parameters major:int .

setMethods	back to summary
public void setMethods(final Method[] methods) Parameters methods:Method[] .

setMinor	back to summary
public void setMinor(final int minor) Parameters minor:int .

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