org.fife.rsta.ac.java.classreader

Class MethodInfo

java.lang.Object

org.fife.rsta.ac.java.classreader.MemberInfo

org.fife.rsta.ac.java.classreader.MethodInfo

All Implemented Interfaces:

AccessFlags

public class MethodInfo
extends MemberInfo
implements AccessFlags

Implementation of the "method_info" structure as defined in the JVM specification.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODE
static java.lang.String	EXCEPTIONS

Fields inherited from class org.fife.rsta.ac.java.classreader.MemberInfo

cf, DEPRECATED, RUNTIME_VISIBLE_ANNOTATIONS, SIGNATURE

Fields inherited from interface org.fife.rsta.ac.java.classreader.AccessFlags

ACC_ABSTRACT, ACC_ANNOTATION, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VOLATILE

Constructor Summary

Constructors

Constructor and Description
MethodInfo(ClassFile cf, int accessFlags, int nameIndex, int descriptorIndex) Constructor.

Method Summary

Modifier and Type	Method and Description
AttributeInfo	getAttribute(int index) Returns the specified attribute.
int	getAttributeCount() Returns the number of attributes of this field.
java.lang.String	getDescriptor() Returns the descriptor of this member.
java.lang.String	getName() Returns the name of this member.
java.lang.String	getNameAndParameters() Returns the name and parameters of this method, in the form performAction(String, int, Runnable).
int	getParameterCount() Returns the number of parameters this method takes.
java.lang.String	getParameterName(int index) If debugging was enabled during compilation, this method returns the name of the given parameter to this method.
java.lang.String	getParameterType(int index, boolean fullyQualified) Returns a string representing the type of a parameter to this method.
java.lang.String[]	getParameterTypes() Returns an array if strings representing the types of all parameters to this method.
java.lang.String	getReturnTypeString(boolean fullyQualified) Returns the return type of this method.
java.lang.String	getSignature() Returns the signature of this method, as determined from its method descriptor.
boolean	isAbstract() Returns whether this method is abstract.
boolean	isConstructor() Returns whether this method is a constructor.
boolean	isNative() Returns whether this method is native.
boolean	isStatic() Returns whether this method is static.
static MethodInfo	read(ClassFile cf, java.io.DataInputStream in) Reads a MethodInfo from an input stream.

Methods inherited from class org.fife.rsta.ac.java.classreader.MemberInfo

getAccessFlags, getClassFile, isDeprecated, isFinal, readAttribute

Methods inherited from class java.lang.Object

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

Field Detail

CODE

public static final java.lang.String CODE

See Also:

Constant Field Values

EXCEPTIONS

public static final java.lang.String EXCEPTIONS

See Also:

Constant Field Values

Constructor Detail

MethodInfo

public MethodInfo(ClassFile cf,
                  int accessFlags,
                  int nameIndex,
                  int descriptorIndex)

Constructor.

Parameters:

cf - The class file defining this method.

Method Detail

getAttribute

public AttributeInfo getAttribute(int index)

Returns the specified attribute.

Parameters:

index - The index of the attribute.

Returns:

The attribute.

getAttributeCount

public int getAttributeCount()

Returns the number of attributes of this field.

Returns:

The number of attributes.

getDescriptor

public java.lang.String getDescriptor()

Returns the descriptor of this member.

Specified by:

getDescriptor in class MemberInfo

Returns:

The descriptor of this member.

getName

public java.lang.String getName()

Returns the name of this member.

Specified by:

getName in class MemberInfo

Returns:

The name of this member.

getNameAndParameters

public java.lang.String getNameAndParameters()

Returns the name and parameters of this method, in the form performAction(String, int, Runnable).

Returns:

The name and parameters of this method.

getParameterCount

public int getParameterCount()

Returns the number of parameters this method takes.

Returns:

The number of parameters this method takes.

See Also:

getParameterTypes(), getParameterType(int, boolean)

getParameterName

public java.lang.String getParameterName(int index)

If debugging was enabled during compilation, this method returns the name of the given parameter to this method. Otherwise, null is returned.

Parameters:

index - The index of the parameter.

Returns:

The name of the parameter, or null.

getParameterType

public java.lang.String getParameterType(int index,
                                         boolean fullyQualified)

Returns a string representing the type of a parameter to this method.

Parameters:

index - The index of the parameter.

fullyQualified - Whether the returned type should be fully qualified. Note that if fully qualified information is not available for the parameters to this method, this parameter will be ignored (but I'm not sure that ever happens).

Returns:

The type of the parameter.

See Also:

getParameterCount(), getParameterTypes()

getParameterTypes

public java.lang.String[] getParameterTypes()

Returns an array if strings representing the types of all parameters to this method. If this method takes no parameters, a zero-length array is returned.

Returns:

The array. These types will likely be fully qualified.

See Also:

getParameterCount(), getParameterType(int, boolean)

getReturnTypeString

public java.lang.String getReturnTypeString(boolean fullyQualified)

Returns the return type of this method.

Returns:

The return type of this method.

getSignature

public java.lang.String getSignature()

Returns the signature of this method, as determined from its method descriptor.

Returns:

The signature of this method.

isAbstract

public boolean isAbstract()

Returns whether this method is abstract.

Returns:

Whether this method is abstract.

isConstructor

public boolean isConstructor()

Returns whether this method is a constructor.

Returns:

Whether this method is a constructor.

isNative

public boolean isNative()

Returns whether this method is native.

Returns:

Whether this method is native.

isStatic

public boolean isStatic()

Returns whether this method is static.

Overrides:

isStatic in class MemberInfo

Returns:

Whether this method is static.

read

public static MethodInfo read(ClassFile cf,
                              java.io.DataInputStream in)
                       throws java.io.IOException

Reads a MethodInfo from an input stream.

Parameters:

cf - The class file defining the method.

in - The input stream to read from.

Returns:

The method information read.

Throws:

java.io.IOException - If an IO error occurs.