FileDocCategorySizeDatePackage
Method.javaAPI DocJava SE 6 API7549Tue Jun 10 00:22:18 BST 2008com.sun.org.apache.bcel.internal.classfile

Method

public final class Method extends FieldOrMethod
This class represents the method info structure, i.e., 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.
version
$Id: Method.java,v 1.1.2.1 2005/07/31 23:46:20 jeffsuttor Exp $
author
M. Dahm

Fields Summary
Constructors Summary
public Method()
Empty constructor, all attributes have to be defined via `setXXX' methods. Use at your own risk.

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

    super(c);
  
Method(DataInputStream file, ConstantPool constant_pool)
Construct object from file stream.

param
file Input stream
throws
IOException
throws
ClassFormatException

    super(file, constant_pool);
  
public Method(int access_flags, int name_index, int signature_index, Attribute[] attributes, ConstantPool constant_pool)

param
access_flags Access rights of method
param
name_index Points to field name in constant pool
param
signature_index Points to encoded signature
param
attributes Collection of attributes
param
constant_pool Array of constants

    super(access_flags, name_index, signature_index, attributes, constant_pool);
  
Methods Summary
public voidaccept(com.sun.org.apache.bcel.internal.classfile.Visitor v)
Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

param
v Visitor object

    v.visitMethod(this);
  
public final com.sun.org.apache.bcel.internal.classfile.Methodcopy(com.sun.org.apache.bcel.internal.classfile.ConstantPool constant_pool)

return
deep copy of this method

    return (Method)copy_(constant_pool);
  
public com.sun.org.apache.bcel.internal.generic.Type[]getArgumentTypes()

return
array of method argument types

    return Type.getArgumentTypes(getSignature());
  
public final com.sun.org.apache.bcel.internal.classfile.CodegetCode()

return
Code attribute of method, if any

    for(int i=0; i < attributes_count; i++)
      if(attributes[i] instanceof Code)
	return (Code)attributes[i];

    return null;
  
public final com.sun.org.apache.bcel.internal.classfile.ExceptionTablegetExceptionTable()

return
ExceptionTable attribute of method, if any, i.e., list all exceptions the method may throw not exception handlers!

    for(int i=0; i < attributes_count; i++)
      if(attributes[i] instanceof ExceptionTable)
	return (ExceptionTable)attributes[i];

    return null;
  
public final com.sun.org.apache.bcel.internal.classfile.LineNumberTablegetLineNumberTable()

return
LineNumberTable of code attribute if any, i.e. the call is forwarded to the Code atribute.

    Code code = getCode();

    if(code != null)
      return code.getLineNumberTable();
    else
      return null;
  
public final com.sun.org.apache.bcel.internal.classfile.LocalVariableTablegetLocalVariableTable()

return
LocalVariableTable of code attribute if any, i.e. the call is forwarded to the Code atribute.

    Code code = getCode();

    if(code != null)
      return code.getLocalVariableTable();
    else
      return null;
  
public com.sun.org.apache.bcel.internal.generic.TypegetReturnType()

return
return type of method

    return Type.getReturnType(getSignature());
  
public final java.lang.StringtoString()
Return string representation close to declaration format, `public static void _main(String[] args) throws IOException', e.g.

return
String representation of the method.

    ConstantUtf8  c;
    String        name, signature, access; // Short cuts to constant pool
    StringBuffer  buf;

    access = Utility.accessToString(access_flags);

    // Get name and signature from constant pool
    c = (ConstantUtf8)constant_pool.getConstant(signature_index, 
						Constants.CONSTANT_Utf8);
    signature = c.getBytes();

    c = (ConstantUtf8)constant_pool.getConstant(name_index, Constants.CONSTANT_Utf8);
    name = c.getBytes();

    signature = Utility.methodSignatureToString(signature, name, access, true,
						getLocalVariableTable());
    buf = new StringBuffer(signature);

    for(int i=0; i < attributes_count; i++) {
      Attribute a = attributes[i];

      if(!((a instanceof Code) || (a instanceof ExceptionTable)))
	buf.append(" [" + a.toString() + "]");
    }

    ExceptionTable e = getExceptionTable();
    if(e != null) {
      String str = e.toString();
      if(!str.equals(""))
	buf.append("\n\t\tthrows " + str);
    }
 
    return buf.toString();