Class FieldOrMethod

java.lang.Object

org.apache.bcel.classfile.AccessFlags

org.apache.bcel.classfile.FieldOrMethod

All Implemented Interfaces:

Cloneable, Node

Direct Known Subclasses:

Field, Method

public abstract class FieldOrMethod
extends AccessFlags
implements Cloneable, Node

Abstract superclass for fields and methods.

Field Summary

Fields

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

Modifier	Constructor	Description
protected	FieldOrMethod(int accessFlags, int nameIndex, int signatureIndex, Attribute[] attributes, ConstantPool constantPool)	Constructs a FieldOrMethod.
protected	FieldOrMethod(DataInput file, ConstantPool constantPool)	Constructs a field or method from a data input using standard Code headers.
protected	FieldOrMethod(DataInputStream file, ConstantPool constantPool)	Deprecated. (6.0) Use FieldOrMethod(java.io.DataInput, ConstantPool) instead.
protected	FieldOrMethod(FieldOrMethod c)	Initialize from another object.

Method Summary

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Node

accept

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accepts a visitor.

Field Details

name_index

@Deprecated
protected int name_index

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter.

signature_index

@Deprecated
protected int signature_index

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter.

attributes

@Deprecated
protected Attribute[] attributes

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter.

attributes_count

@Deprecated
protected int attributes_count

Deprecated.

(since 6.0) will be removed (not needed)

constant_pool

@Deprecated
protected ConstantPool constant_pool

Deprecated.

(since 6.0) will be made private; do not access directly, use getter/setter.

Constructor Details

FieldOrMethod

protected FieldOrMethod(DataInput file,
 ConstantPool constantPool)
                 throws IOException

Constructs a field or method from a data input using standard Code headers.

Parameters:

file - Input stream.

constantPool - The constant pool.

Throws:

IOException - Thrown if an I/O error occurs.

ClassFormatException - Thrown if the field or method, or one of its attributes, is malformed.

FieldOrMethod

@Deprecated
protected FieldOrMethod(DataInputStream file,
 ConstantPool constantPool)
                 throws IOException

Deprecated.

(6.0) Use FieldOrMethod(java.io.DataInput, ConstantPool) instead.

Constructs a field or method from a data input stream using standard Code headers.

Parameters:

file - Input stream.

constantPool - The constant pool.

Throws:

IOException - Thrown if an I/O error occurs.

ClassFormatException - Thrown if the field or method, or one of its attributes, is malformed.

FieldOrMethod

protected FieldOrMethod(FieldOrMethod 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.

FieldOrMethod

protected FieldOrMethod(int accessFlags,
 int nameIndex,
 int signatureIndex,
 Attribute[] attributes,
 ConstantPool constantPool)

Constructs a FieldOrMethod.

Parameters:

accessFlags - Access rights of the field or method.

nameIndex - Points to the field or method name in the constant pool.

signatureIndex - Points to encoded signature.

attributes - Collection of attributes.

constantPool - Array of constants.

Method Details

copy_

protected FieldOrMethod copy_(ConstantPool constantPool)

Creates a deep copy of this field.

Parameters:

constantPool - The constant pool.

Returns:

deep copy of this field.

dump

public final void dump(DataOutputStream file)
                throws IOException

Dumps object to file stream on binary format.

Parameters:

file - Output file stream.

Throws:

IOException - Thrown if an I/O error occurs.

getAnnotationEntries

public AnnotationEntry[] getAnnotationEntries()

Gets annotations on the field or method.

Returns:

Annotations on the field or method.

Since:

6.0

getAttribute

public final <T extends Attribute> T getAttribute(byte tag)

Gets attribute for given tag.

Type Parameters:

T - The attribute type.

Parameters:

tag - The attribute tag.

Returns:

Attribute for given tag, null if not found. Refer to Const.ATTR_UNKNOWN constants named ATTR_* for possible values.

Since:

6.10.0

getAttributes

public final Attribute[] getAttributes()

Gets the collection of object attributes.

Returns:

Collection of object attributes.

getConstantPool

public final ConstantPool getConstantPool()

Gets the constant pool used by this object.

Returns:

Constant pool used by this object.

getGenericSignature

public final String getGenericSignature()

Gets the contents of the signature attribute on this member. So where the 'regular' signature may be (Ljava/util/Vector;)V the signature attribute may in fact say 'Ljava/lang/Vector<Ljava/lang/String>;' Coded for performance - searches for the attribute only when requested - only searches for it once.

Returns:

The generic signature.

Since:

6.0

getName

public final String getName()

Gets the name of object.

Returns:

Name of object, that is, method name or field name.

getNameIndex

public final int getNameIndex()

Gets the index in constant pool of object's name.

Returns:

Index in constant pool of object's name.

getSignature

public final String getSignature()

Gets the string representation of object's type signature.

Returns:

String representation of object's type signature (Java style).

getSignatureIndex

public final int getSignatureIndex()

Gets the index in constant pool of field signature.

Returns:

Index in constant pool of field signature.

setAttributes

public final void setAttributes(Attribute[] attributes)

Sets the collection of object attributes.

Parameters:

attributes - Collection of object attributes.

setConstantPool

public final void setConstantPool(ConstantPool constantPool)

Sets the constant pool to be used for this object.

Parameters:

constantPool - Constant pool to be used for this object.

setNameIndex

public final void setNameIndex(int nameIndex)

Sets the index in constant pool of object's name.

Parameters:

nameIndex - Index in constant pool of object's name.

setSignatureIndex

public final void setSignatureIndex(int signatureIndex)

Sets the index in constant pool of field signature.

Parameters:

signatureIndex - Index in constant pool of field signature.