org.clapper.util.classutil

Class MethodInfo

java.lang.Object

org.clapper.util.classutil.MethodInfo

All Implemented Interfaces:

java.lang.Comparable<MethodInfo>

public class MethodInfo
extends java.lang.Object
implements java.lang.Comparable<MethodInfo>

Holds information about a method within a class.

See Also:

ClassInfo

Constructor Summary

Constructors

Constructor and Description
MethodInfo() Create a new, empty MethodInfo object.
MethodInfo(int access, java.lang.String name, java.lang.String description, java.lang.String signature, java.lang.String[] exceptions) Create and initialize a new MethodInfo object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MethodInfo other) Compare this object and another MethodInfo object.
boolean	equals(java.lang.Object other) Compare this object to another one for equality.
int	getAccess() Get the access modifiers for this method.
java.lang.String	getDescription() Get the method description, if any.
java.lang.String[]	getExceptions() Get the class names of the thrown exceptions
java.lang.String	getName() Get the method name.
java.lang.String	getSignature() Get the method's signature, if any.
int	hashCode() Get the hash code.
java.lang.String	toString() Return a string representation of the method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodInfo

public MethodInfo()

Create a new, empty MethodInfo object.

MethodInfo

public MethodInfo(int access,
                  java.lang.String name,
                  java.lang.String description,
                  java.lang.String signature,
                  java.lang.String[] exceptions)

Create and initialize a new MethodInfo object.

Parameters:

access - method access modifiers, etc.

name - method name

description - method description

signature - method signature

exceptions - list of thrown exceptions (by name)

Method Detail

getAccess

public int getAccess()

Get the access modifiers for this method.

Returns:

the access modifiers, or 0 if none are set.

getName

public java.lang.String getName()

Get the method name.

Returns:

the method name

getDescription

public java.lang.String getDescription()

Get the method description, if any.

Returns:

the method description, or null

getSignature

public java.lang.String getSignature()

Get the method's signature, if any.

Returns:

the method signature, or null.

getExceptions

public java.lang.String[] getExceptions()

Get the class names of the thrown exceptions

Returns:

the names of the thrown exceptions, or null.

hashCode

public int hashCode()

Get the hash code. The hash code is based on the field's signature.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

compareTo

public int compareTo(MethodInfo other)

Compare this object and another MethodInfo object. The two objects are compared by their signature fields.

Specified by:

compareTo in interface java.lang.Comparable<MethodInfo>

Parameters:

other - the other object

Returns:

a negative integer, zero, or a positive integer, as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(java.lang.Object other)

Compare this object to another one for equality. If the other object is a MethodInfo instance, the two will be compared by signature.

Overrides:

equals in class java.lang.Object

Parameters:

other - the other object

Returns:

true if other is a MethodInfo object and it has the same signature as this object, false otherwise.

toString

public java.lang.String toString()

Return a string representation of the method. Currently, the string representation is just the method's signature, or the name if the signature is null.

Overrides:

toString in class java.lang.Object

Returns:

a string representation