org.jace.parser.method

Class ClassMethod

java.lang.Object

org.jace.parser.method.ClassMethod

public class ClassMethod
extends Object

Represents a class or instance method.

Author:

Toby Reyelts, Gili Tzabari

Constructor Summary

Constructors

Constructor and Description
ClassMethod(InputStream stream, ConstantPool pool) Reads in a ClassMethod from a Java class file.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(Attribute a)
MethodAccessFlagSet	getAccessFlags() Returns the MethodAccessFlagSet for this ClassMethod.
List<Attribute>	getAttributes()
CodeAttribute	getCode()
String	getDescriptor() Returns the descriptor for this ClassMethod.
int	getDescriptorIndex()
Collection<TypeName>	getExceptions() Returns the exceptions which have been declared for this ClassMethod.
String	getName() Returns the name of this ClassMethod.
int	getNameIndex()
List<TypeName>	getParameterTypes() Returns the parameter types for this ClassMethod.
TypeName	getReturnType() Returns the return type for this ClassMethod.
void	setAccessFlags(MethodAccessFlagSet set)
void	setDescriptorIndex(int index)
void	setNameIndex(int index)
String	toString() Returns a String that contains debugging information for this ClassMethod.
void	write(DataOutputStream output)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassMethod

public ClassMethod(InputStream stream,
           ConstantPool pool)
            throws IOException

Reads in a ClassMethod from a Java class file.

Parameters:

stream - The InputStream from which this ClassMethod will be read. The stream must be pointing to the beginning of a valid method definition as detailed in the JVM specification.

pool - The ConstantPool for the class file to which this ClassMethod belongs.

Throws:

IOException - if an error occurs while trying to read the ClassMethod.

Method Detail

write

public void write(DataOutputStream output)
           throws IOException

Throws:

IOException

getAttributes

public List<Attribute> getAttributes()

getCode

public CodeAttribute getCode()

addAttribute

public void addAttribute(Attribute a)

getAccessFlags

public MethodAccessFlagSet getAccessFlags()

Returns the MethodAccessFlagSet for this ClassMethod.

Returns:

the MethodAccessFlagSet for this ClassMethod

setAccessFlags

public void setAccessFlags(MethodAccessFlagSet set)

getNameIndex

public int getNameIndex()

setNameIndex

public void setNameIndex(int index)

getDescriptorIndex

public int getDescriptorIndex()

setDescriptorIndex

public void setDescriptorIndex(int index)

getName

public String getName()

Returns the name of this ClassMethod. For example, "execute"

Returns:

the name of this ClassMethod

Throws:

RuntimeException - that should probably instead be ClassFormatError.

getDescriptor

public String getDescriptor()
                     throws ClassFormatError

Returns the descriptor for this ClassMethod. For example, "(Ljava/lang/String;I)[B", which would have a signature of: byte[] xxx( java.lang.String aString, int anInt )

Returns:

the method descriptor

Throws:

ClassFormatError - if the descriptor isn't of the right type. This should probably be thrown during the parsing stage.

getReturnType

public TypeName getReturnType()

Returns the return type for this ClassMethod. The return type is formatted in internal format. For example, Ljava/lang/String or [B

Returns:

the return type for this ClassMethod

getParameterTypes

public List<TypeName> getParameterTypes()

Returns the parameter types for this ClassMethod. The parameter types are formatted in internal format. For example, Ljava/lang/String or [B

Returns:

an unmodifiable list of type names

getExceptions

public Collection<TypeName> getExceptions()

Returns the exceptions which have been declared for this ClassMethod.

Returns:

the exceptions which have been declared for this ClassMethod

toString

public String toString()

Returns a String that contains debugging information for this ClassMethod.

Overrides:

toString in class Object

Returns:

a String that contains debugging information for this ClassMethod