OpenJDK 1.22 · com.sun.org.apache.bcel.internal.generic.ClassGen

Field Summary

Modifier and Type	Field and Description
private final List<AnnotationEntryGen>	annotationList
private final List<Attribute>	attributeList
private static BCELComparator	bcelComparator
private String	className
private int	classNameIndex
private ConstantPoolGen	cp
private final List<Field>	fieldList
private final String	fileName
private final List<String>	interfaceList
private int	major
private final List<Method>	methodList
private int	minor
private List<ClassObserver>	observers
private String	superClassName
private int	superclassNameIndex

Inherited from com.sun.org.apache.bcel.internal.classfile.AccessFlags:: access_flags

Constructor Summary

Access	Constructor and Description
public	ClassGen(final JavaClass JavaClass object (e.g. read from file) clazz) Initialize with existing class.
public	ClassGen(final String fully qualified class name className, final String fully qualified superclass name superClassName, final String source file name fileName, final int access qualifiers accessFlags, final String[] implemented interfaces interfaces) Convenience constructor to set up some important values initially.
public	ClassGen(final String fully qualified class name className, final String fully qualified superclass name superClassName, final String source file name fileName, final int access qualifiers accessFlags, final String[] implemented interfaces interfaces, final ConstantPoolGen constant pool to use cp) Convenience constructor to set up some important values initially.

Method Summary

Modifier and Type	Method and Description
public void	addAnnotationEntry(final AnnotationEntryGen a)
public void	addAttribute(final Attribute attribute to add a) Add an attribute to this class.
public void	addEmptyConstructor(final int rights for constructor accessFlags) Convenience method.
public void	addField(final Field field to add f) Add a field to this class.
public void	addInterface(final String interface to implement (fully qualified class name) name) Add an interface to this class, i.e., this class has to implement it.
public void	addMethod(final Method method to add m) Add a method to this class.
public void	addObserver(final ClassObserver o) Add observer for this object.
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	containsField(final Field f)
public Field	Returns: field object with given name, or null containsField(final String name)
public Method	Returns: method object with given name and signature, or null containsMethod(final String name, final String signature)
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 AnnotationEntryGen[]	getAnnotationEntries()
public Attribute[]	getAttributes()
public String	getClassName()
public int	getClassNameIndex()
public static BCELComparator	Returns: Comparison strategy object getComparator()
public ConstantPoolGen	getConstantPool()
public Field[]	getFields()
public String	getFileName()
public String[]	getInterfaceNames()
public int[]	getInterfaces()
public JavaClass	Returns: the (finally) built up Java class object. getJavaClass()
public int	Returns: major version number of class file getMajor()
public Method	getMethodAt(final int pos)
public Method[]	getMethods()
public int	Returns: minor version number of class file getMinor()
public String	getSuperclassName()
public int	getSuperclassNameIndex()
public int	hashCode() Overrides java.lang.Object.hashCode. Return value as defined by given BCELComparator strategy.
public void	removeAttribute(final Attribute attribute to remove a) Remove an attribute from this class.
public void	removeField(final Field field to remove f) Remove a field to this class.
public void	removeInterface(final String interface to remove (fully qualified name) name) Remove an interface from this class.
public void	removeMethod(final Method method to remove m) Remove a method from this class.
public void	removeObserver(final ClassObserver o) Remove observer for this object.
public void	replaceField(final Field old, final Field newField) Replace given field with new one.
public void	replaceMethod(final Method old, final Method newMethod) Replace given method with new one.
public void	setClassName(final String name)
public void	setClassNameIndex(final int classNameIndex)
public static void	setComparator(final BCELComparator Comparison strategy object comparator)
public void	setConstantPool(final ConstantPoolGen constantPool)
public void	setMajor(final int major version number major) Set major version number of class file, default value is 45 (JDK 1.1)
public void	setMethodAt(final Method method, final int pos)
public void	setMethods(final Method[] methods)
public void	setMinor(final int minor version number minor) Set minor version number of class file, default value is 3 (JDK 1.1)
public void	setSuperclassName(final String name)
public void	setSuperclassNameIndex(final int superclassNameIndex)
private AnnotationEntryGen[]	unpackAnnotations(final Attribute[] attrs) Look for attributes representing annotations and unpack them.
public void	update() Call notify() method on all observers.

Field Detail

annotationList	back to summary
private final List<AnnotationEntryGen> annotationList

attributeList	back to summary
private final List<Attribute> attributeList

bcelComparator	back to summary
private static BCELComparator bcelComparator

className	back to summary
private String className

classNameIndex	back to summary
private int classNameIndex

cp	back to summary
private ConstantPoolGen cp

fieldList	back to summary
private final List<Field> fieldList

fileName	back to summary
private final String fileName

interfaceList	back to summary
private final List<String> interfaceList

major	back to summary
private int major

methodList	back to summary
private final List<Method> methodList

minor	back to summary
private int minor

observers	back to summary
private List<ClassObserver> observers

superClassName	back to summary
private String superClassName

superclassNameIndex	back to summary
private int superclassNameIndex

Constructor Detail

ClassGen	back to summary
public ClassGen(final JavaClass clazz) Initialize with existing class. Parameters clazz:JavaClass JavaClass object (e.g. read from file)

ClassGen

back to summary

public ClassGen(final JavaClass clazz)

Initialize with existing class.

Parameters

clazz:JavaClass: JavaClass object (e.g. read from file)

ClassGen	back to summary
public ClassGen(final String className, final String superClassName, final String fileName, final int accessFlags, final String[] interfaces) Convenience constructor to set up some important values initially. Parameters className:String fully qualified class name superClassName:String fully qualified superclass name fileName:String source file name accessFlags:int access qualifiers interfaces:String[] implemented interfaces

ClassGen

back to summary

public ClassGen(final String className, final String superClassName, final String fileName, final int accessFlags, final String[] interfaces)

Convenience constructor to set up some important values initially.

Parameters

className:String: fully qualified class name
superClassName:String: fully qualified superclass name
fileName:String: source file name
accessFlags:int: access qualifiers
interfaces:String[]: implemented interfaces

ClassGen	back to summary
public ClassGen(final String className, final String superClassName, final String fileName, final int accessFlags, final String[] interfaces, final ConstantPoolGen cp) Convenience constructor to set up some important values initially. Parameters className:String fully qualified class name superClassName:String fully qualified superclass name fileName:String source file name accessFlags:int access qualifiers interfaces:String[] implemented interfaces cp:ConstantPoolGen constant pool to use

ClassGen

back to summary

public ClassGen(final String className, final String superClassName, final String fileName, final int accessFlags, final String[] interfaces, final ConstantPoolGen cp)

Convenience constructor to set up some important values initially.

Parameters

className:String: fully qualified class name
superClassName:String: fully qualified superclass name
fileName:String: source file name
accessFlags:int: access qualifiers
interfaces:String[]: implemented interfaces
cp:ConstantPoolGen: constant pool to use

Method Detail

addAnnotationEntry	back to summary
public void addAnnotationEntry(final AnnotationEntryGen a)

addAttribute	back to summary
public void addAttribute(final Attribute a) Add an attribute to this class. Parameters a:Attribute attribute to add

addAttribute

back to summary

public void addAttribute(final Attribute a)

Add an attribute to this class.

Parameters

a:Attribute: attribute to add

addEmptyConstructor	back to summary
public void addEmptyConstructor(final int accessFlags) Convenience method. Add an empty constructor to this class that does nothing but calling super(). Parameters accessFlags:int rights for constructor

addEmptyConstructor

back to summary

public void addEmptyConstructor(final int accessFlags)

Convenience method. Add an empty constructor to this class that does nothing but calling super().

Parameters

accessFlags:int: rights for constructor

addField	back to summary
public void addField(final Field f) Add a field to this class. Parameters f:Field field to add

addField

back to summary

public void addField(final Field f)

Add a field to this class.

Parameters

f:Field: field to add

addInterface	back to summary
public void addInterface(final String name) Add an interface to this class, i.e., this class has to implement it. Parameters name:String interface to implement (fully qualified class name)

addInterface

back to summary

public void addInterface(final String name)

Add an interface to this class, i.e., this class has to implement it.

Parameters

name:String: interface to implement (fully qualified class name)

addMethod	back to summary
public void addMethod(final Method m) Add a method to this class. Parameters m:Method method to add

addMethod

back to summary

public void addMethod(final Method m)

Add a method to this class.

Parameters

m:Method: method to add

addObserver	back to summary
public void addObserver(final ClassObserver o) Add observer for this object.

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

containsField	back to summary
public boolean containsField(final Field f)

containsField	back to summary
public Field containsField(final String name) Returns:Field field object with given name, or null

containsMethod	back to summary
public Method containsMethod(final String name, final String signature) Returns:Method method object with given name and signature, or null

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 ClassGen 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 ClassGen 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)

getAnnotationEntries	back to summary
public AnnotationEntryGen[] getAnnotationEntries()

getAttributes	back to summary
public Attribute[] getAttributes()

getClassName	back to summary
public String getClassName()

getClassNameIndex	back to summary
public int getClassNameIndex()

getComparator	back to summary
public static BCELComparator getComparator() Returns:BCELComparator Comparison strategy object

getConstantPool	back to summary
public ConstantPoolGen getConstantPool()

getFields	back to summary
public Field[] getFields()

getFileName	back to summary
public String getFileName()

getInterfaceNames	back to summary
public String[] getInterfaceNames()

getInterfaces	back to summary
public int[] getInterfaces()

getJavaClass	back to summary
public JavaClass getJavaClass() Returns:JavaClass the (finally) built up Java class object.

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

getMethodAt	back to summary
public Method getMethodAt(final int pos)

getMethods	back to summary
public Method[] getMethods()

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

getSuperclassName	back to summary
public String getSuperclassName()

getSuperclassNameIndex	back to summary
public int getSuperclassNameIndex()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Return value as defined by given BCELComparator strategy. By default return the hashcode 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()

removeAttribute

back to summary

public void removeAttribute(final Attribute a)

Remove an attribute from this class.

Parameters

a:Attribute: attribute to remove

removeField

back to summary

public void removeField(final Field f)

Remove a field to this class.

Parameters

f:Field: field to remove

removeInterface

back to summary

public void removeInterface(final String name)

Remove an interface from this class.

Parameters

name:String: interface to remove (fully qualified name)

removeMethod

back to summary

public void removeMethod(final Method m)

Remove a method from this class.

Parameters

m:Method: method to remove

removeObserver	back to summary
public void removeObserver(final ClassObserver o) Remove observer for this object.

replaceField	back to summary
public void replaceField(final Field old, final Field newField) Replace given field with new one. If the old one does not exist add the new_ field to the class anyway.

replaceMethod	back to summary
public void replaceMethod(final Method old, final Method newMethod) Replace given method with new one. If the old one does not exist add the newMethod method to the class anyway.

setClassName	back to summary
public void setClassName(final String name)

setClassNameIndex	back to summary
public void setClassNameIndex(final int classNameIndex)

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

setConstantPool	back to summary
public void setConstantPool(final ConstantPoolGen constantPool)

setMajor

back to summary

public void setMajor(final int major)

Set major version number of class file, default value is 45 (JDK 1.1)

Parameters

major:int: major version number

setMethodAt	back to summary
public void setMethodAt(final Method method, final int pos)

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

setMinor

back to summary

public void setMinor(final int minor)

Set minor version number of class file, default value is 3 (JDK 1.1)

Parameters

minor:int: minor version number

setSuperclassName	back to summary
public void setSuperclassName(final String name)

setSuperclassNameIndex	back to summary
public void setSuperclassNameIndex(final int superclassNameIndex)

unpackAnnotations	back to summary
private AnnotationEntryGen[] unpackAnnotations(final Attribute[] attrs) Look for attributes representing annotations and unpack them.

update	back to summary
public void update() Call notify() method on all observers. This method is not called automatically whenever the state has changed, but has to be called by the user after they have finished editing the object.

public Class ClassGen

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail