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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Signature.MyByteArrayInputStream	Extends ByteArrayInputStream to make 'unreading' chars possible.

Field Summary

Fields

Modifier and Type	Field	Description
private int	signatureIndex

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)
Signature(int nameIndex, int length, java.io.DataInput input, ConstantPool constantPool)	Constructs object from file stream.
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)
void	dump(java.io.DataOutputStream file)	Dump source file attribute to file stream in binary format.
java.lang.String	getSignature()
int	getSignatureIndex()
private static boolean	identStart(int ch)
static boolean	isActualParameterList(java.lang.String s)
static boolean	isFormalParameterList(java.lang.String s)
private static void	matchGJIdent(Signature.MyByteArrayInputStream in, java.lang.StringBuilder buf)
private static void	matchIdent(Signature.MyByteArrayInputStream in, java.lang.StringBuilder buf)
void	setSignatureIndex(int signatureIndex)
java.lang.String	toString()
static java.lang.String	translate(java.lang.String s)

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

Field Detail

signatureIndex

private int signatureIndex

Constructor Detail

Signature

Signature(int nameIndex,
          int length,
          java.io.DataInput input,
          ConstantPool constantPool)
   throws java.io.IOException

Constructs object from file stream.

Parameters:

nameIndex - Index in constant pool to CONSTANT_Utf8

length - Content length in bytes

input - Input stream

constantPool - Array of constants

Throws:

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

Signature

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

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

identStart

private static boolean identStart(int ch)

isActualParameterList

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

isFormalParameterList

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

matchGJIdent

private static void matchGJIdent(Signature.MyByteArrayInputStream in,
                                 java.lang.StringBuilder buf)

matchIdent

private static void matchIdent(Signature.MyByteArrayInputStream in,
                               java.lang.StringBuilder buf)

translate

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

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)

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

Dump source file attribute to file stream in binary format.

Overrides:

dump in class Attribute

Parameters:

file - Output file stream

Throws:

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

getSignature

public java.lang.String getSignature()

Returns:

GJ signature.

getSignatureIndex

public int getSignatureIndex()

Returns:

Index in constant pool of source file name.

setSignatureIndex

public void setSignatureIndex(int signatureIndex)

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