Class Method

java.lang.Object

org.apache.bcel.classfile.AccessFlags

org.apache.bcel.classfile.FieldOrMethod

org.apache.bcel.classfile.Method

All Implemented Interfaces:

Cloneable, Node

public final class Method
extends FieldOrMethod

This class represents the method info structure, that is, the representation for a method in the class. See JVM specification for details. A method has access flags, a name, a signature and a number of attributes.

Field Summary

Fields

Modifier and Type	Field	Description
static final Method[]	EMPTY_ARRAY	Empty array constant.

Fields inherited from class FieldOrMethod

attributes, attributes_count, constant_pool, name_index, signature_index

Modifier and Type	Field	Description
protected Attribute[]	attributes	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
protected int	attributes_count	Deprecated. (since 6.0) will be removed (not needed)
protected ConstantPool	constant_pool	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
protected int	name_index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
protected int	signature_index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.

Fields inherited from class AccessFlags

access_flags

Modifier and Type	Field	Description
protected int	access_flags	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.

Constructor Summary

Constructors

Constructor	Description
Method()	Empty constructor, all attributes have to be defined via 'setXXX' methods.
Method(int accessFlags, int nameIndex, int signatureIndex, Attribute[] attributes, ConstantPool constantPool)	Constructs a Method.
Method(Method c)	Initialize from another object.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
Method	copy(ConstantPool constantPool)	Creates a deep copy of this method.
boolean	equals(Object obj)	Return value as defined by given BCELComparator strategy.
Type[]	getArgumentTypes()	Gets an array of method argument types.
Code	getCode()	Gets the Code attribute of the method, if any.
static BCELComparator<Method>	getComparator()	Gets the comparison strategy object.
ExceptionTable	getExceptionTable()	Gets the ExceptionTable attribute of the method, if any.
LineNumberTable	getLineNumberTable()	Gets the LineNumberTable of the code attribute, if any.
LocalVariableTable	getLocalVariableTable()	Gets the LocalVariableTable of the code attribute, if any.
LocalVariableTypeTable	getLocalVariableTypeTable()	Gets the local variable type table attribute LocalVariableTypeTable.
ParameterAnnotationEntry[]	getParameterAnnotationEntries()	Gets the annotations on the parameters of a method.
Type	getReturnType()	Gets return type of method.
int	hashCode()	Return value as defined by given BCELComparator strategy.
static void	setComparator(BCELComparator<Method> comparator)	Sets the comparison strategy object.
String	toString()	Return string representation close to declaration format, 'public static void main(String[] args) throws IOException', for example.

Methods inherited from class FieldOrMethod

copy_, dump, getAnnotationEntries, getAttribute, getAttributes, getConstantPool, getGenericSignature, getName, getNameIndex, getSignature, getSignatureIndex, setAttributes, setConstantPool, setNameIndex, setSignatureIndex

Modifier and Type	Method	Description
protected FieldOrMethod	copy_(ConstantPool constantPool)	Creates a deep copy of this field.
final void	dump(DataOutputStream file)	Dumps object to file stream on binary format.
AnnotationEntry[]	getAnnotationEntries()	Gets annotations on the field or method.
final <T extends Attribute> T	getAttribute(byte tag)	Gets attribute for given tag.
final Attribute[]	getAttributes()	Gets the collection of object attributes.
final ConstantPool	getConstantPool()	Gets the constant pool used by this object.
final String	getGenericSignature()	Gets the contents of the signature attribute on this member.
final String	getName()	Gets the name of object.
final int	getNameIndex()	Gets the index in constant pool of object's name.
final String	getSignature()	Gets the string representation of object's type signature.
final int	getSignatureIndex()	Gets the index in constant pool of field signature.
final void	setAttributes(Attribute[] attributes)	Sets the collection of object attributes.
final void	setConstantPool(ConstantPool constantPool)	Sets the constant pool to be used for this object.
final void	setNameIndex(int nameIndex)	Sets the index in constant pool of object's name.
final void	setSignatureIndex(int signatureIndex)	Sets the index in constant pool of field signature.

Methods inherited from class 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, isVarArgs, isVarArgs, isVolatile, isVolatile, setAccessFlags, setModifiers

Modifier and Type	Method	Description
final int	getAccessFlags()	Gets access flags.
final int	getModifiers()	Gets access flags.
final boolean	isAbstract()	Tests whether the abstract bit is on.
final void	isAbstract(boolean flag)	Sets the abstract bit.
final boolean	isAnnotation()	Tests whether the annotation bit is on.
final void	isAnnotation(boolean flag)	Sets the annotation bit.
final boolean	isEnum()	Tests whether the enum bit is on.
final void	isEnum(boolean flag)	Sets the enum bit.
final boolean	isFinal()	Tests whether the final bit is on.
final void	isFinal(boolean flag)	Sets the final bit.
final boolean	isInterface()	Tests whether the interface bit is on.
final void	isInterface(boolean flag)	Sets the interface bit.
final boolean	isNative()	Tests whether the native bit is on.
final void	isNative(boolean flag)	Sets the native bit.
final boolean	isPrivate()	Tests whether the private bit is on.
final void	isPrivate(boolean flag)	Sets the private bit.
final boolean	isProtected()	Tests whether the protected bit is on.
final void	isProtected(boolean flag)	Sets the protected bit.
final boolean	isPublic()	Tests whether the public bit is on.
final void	isPublic(boolean flag)	Sets the public bit.
final boolean	isStatic()	Tests whether the static bit is on.
final void	isStatic(boolean flag)	Sets the static bit.
final boolean	isStrictfp()	Tests whether the strict bit is on.
final void	isStrictfp(boolean flag)	Sets the strict bit.
final boolean	isSynchronized()	Tests whether the synchronized bit is on.
final void	isSynchronized(boolean flag)	Sets the synchronized bit.
final boolean	isSynthetic()	Tests whether the synthetic bit is on.
final void	isSynthetic(boolean flag)	Sets the synthetic bit.
final boolean	isTransient()	Tests whether the transient bit is on.
final void	isTransient(boolean flag)	Sets the transient bit.
final boolean	isVarArgs()	Tests whether the varargs bit is on.
final void	isVarArgs(boolean flag)	Sets the varargs bit.
final boolean	isVolatile()	Tests whether the volatile bit is on.
final void	isVolatile(boolean flag)	Sets the volatile bit.
final void	setAccessFlags(int accessFlags)	Sets access flags also known as modifiers.
final void	setModifiers(int accessFlags)	Sets access flags aka "modifiers".

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_ARRAY

public static final Method[] EMPTY_ARRAY

Empty array constant.

Since:

6.6.0

Constructor Details

Method

public Method()

Empty constructor, all attributes have to be defined via 'setXXX' methods. Use at your own risk.

Method

public Method(int accessFlags,
 int nameIndex,
 int signatureIndex,
 Attribute[] attributes,
 ConstantPool constantPool)

Constructs a Method.

Parameters:

accessFlags - Access rights of method.

nameIndex - Points to method name in constant pool.

signatureIndex - Points to encoded signature.

attributes - Collection of attributes.

constantPool - Array of constants.

Method

public Method(Method c)

Initialize from another object. Note that both objects use the same references (shallow copy). Use clone() for a physical copy.

Parameters:

c - Source to copy.

Method Details

getComparator

public static BCELComparator<Method> getComparator()

Gets the comparison strategy object.

Returns:

Comparison strategy object.

setComparator

public static void setComparator(BCELComparator<Method> comparator)

Sets the comparison strategy object.

Parameters:

comparator - Comparison strategy object.

accept

public void accept(Visitor v)

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. That is, the hierarchy of methods, fields, attributes, and other elements forms a tree of objects.

Parameters:

v - Visitor object.

copy

public Method copy(ConstantPool constantPool)

Creates a deep copy of this method.

Parameters:

constantPool - The constant pool.

Returns:

deep copy of this method.

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

See Also:

• Object.equals(Object)

getArgumentTypes

public Type[] getArgumentTypes()

Gets an array of method argument types.

Returns:

array of method argument types.

getCode

public Code getCode()

Gets the Code attribute of the method, if any.

Returns:

Code attribute of method, if any.

getExceptionTable

public ExceptionTable getExceptionTable()

Gets the ExceptionTable attribute of the method, if any.

Returns:

ExceptionTable attribute of method, if any, that is, list all exceptions the method may throw not exception handlers.

getLineNumberTable

public LineNumberTable getLineNumberTable()

Gets the LineNumberTable of the code attribute, if any.

Returns:

LineNumberTable of code attribute if any, for example the call is forwarded to the Code attribute.

getLocalVariableTable

public LocalVariableTable getLocalVariableTable()

Gets the LocalVariableTable of the code attribute, if any.

Returns:

LocalVariableTable of code attribute if any, for example the call is forwarded to the Code attribute.

getLocalVariableTypeTable

public LocalVariableTypeTable getLocalVariableTypeTable()

Gets the local variable type table attribute LocalVariableTypeTable.

Returns:

LocalVariableTypeTable of code attribute if any, for example the call is forwarded to the Code attribute.

Since:

6.10.0

getParameterAnnotationEntries

public ParameterAnnotationEntry[] getParameterAnnotationEntries()

Gets the annotations on the parameters of a method.

Returns:

Annotations on the parameters of a method.

Since:

6.0

getReturnType

public Type getReturnType()

Gets return type of method.

Returns:

return type of method.

hashCode

public int hashCode()

Return value as defined by given BCELComparator strategy. By default return the hash code of the method's name XOR signature.

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toString

public String toString()

Return string representation close to declaration format, 'public static void main(String[] args) throws IOException', for example.

Overrides:

toString in class Object

Returns:

String representation of the method.