Package org.apache.bcel.classfile

Class Signature

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.Signature

All Implemented Interfaces:

java.lang.Cloneable, Node

public final class Signature
extends Attribute

This class is derived from Attribute and represents a reference to a GJ attribute.

See Also:

Attribute

Field Summary

Fields inherited from class org.apache.bcel.classfile.Attribute

constant_pool, EMPTY_ARRAY, length, name_index, tag

Constructor Summary

Constructors

Constructor	Description
Signature(int nameIndex, int length, int signatureIndex, ConstantPool constantPool)	Constructs a Signature.
Signature(Signature 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.
Attribute	copy(ConstantPool constantPool)	Creates a deep copy of this attribute.
void	dump(java.io.DataOutputStream file)	Dumps source file attribute to file stream in binary format.
java.lang.String	getSignature()	Gets the GJ signature.
int	getSignatureIndex()	Gets the signature index.
static boolean	isActualParameterList(java.lang.String s)	Tests if a string is an actual parameter list.
static boolean	isFormalParameterList(java.lang.String s)	Tests if a string is a formal parameter list.
void	setSignatureIndex(int signatureIndex)	Sets the signature index.
java.lang.String	toString()
static java.lang.String	translate(java.lang.String s)	Translates a signature string.

Methods inherited from class org.apache.bcel.classfile.Attribute

addAttributeReader, addAttributeReader, clone, getConstantPool, getLength, getName, getNameIndex, getTag, println, readAttribute, readAttribute, removeAttributeReader, setConstantPool, setLength, setNameIndex

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Signature

public Signature(int nameIndex,
                 int length,
                 int signatureIndex,
                 ConstantPool constantPool)

Constructs a Signature.

Parameters:

nameIndex - Index in constant pool to CONSTANT_Utf8.

length - Content length in bytes.

signatureIndex - Index in constant pool to CONSTANT_Utf8.

constantPool - Array of constants.

Signature

public Signature(Signature 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 Detail

isActualParameterList

public static boolean isActualParameterList(java.lang.String s)

Tests if a string is an actual parameter list.

Parameters:

s - The string to test.

Returns:

true if the string is an actual parameter list.

Since:

6.0 is no longer final

isFormalParameterList

public static boolean isFormalParameterList(java.lang.String s)

Tests if a string is a formal parameter list.

Parameters:

s - The string to test.

Returns:

true if the string is a formal parameter list.

Since:

6.0 is no longer final

translate

public static java.lang.String translate(java.lang.String s)

Translates a signature string.

Parameters:

s - The signature string.

Returns:

The translated signature.

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. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

Specified by:

accept in interface Node

Specified by:

accept in class Attribute

Parameters:

v - Visitor object.

copy

public Attribute copy(ConstantPool constantPool)

Description copied from class: Attribute

Creates a deep copy of this attribute.

Specified by:

copy in class Attribute

Parameters:

constantPool - constant pool to save.

Returns:

deep copy of this attribute.

dump

public void dump(java.io.DataOutputStream file)
          throws java.io.IOException

Dumps source file attribute to file stream in binary format.

Overrides:

dump in class Attribute

Parameters:

file - Output file stream.

Throws:

java.io.IOException - Thrown if an I/O error occurs.

getSignature

public java.lang.String getSignature()

Gets the GJ signature.

Returns:

GJ signature.

getSignatureIndex

public int getSignatureIndex()

Gets the signature index.

Returns:

Index in constant pool of source file name.

setSignatureIndex

public void setSignatureIndex(int signatureIndex)

Sets the signature index.

Parameters:

signatureIndex - The index info the constant pool of this signature.

toString

public java.lang.String toString()

Overrides:

toString in class Attribute

Returns:

String representation.