Package org.openjdk.jmc.common.util

Class MCMethod

java.lang.Object

org.openjdk.jmc.common.util.MCMethod

All Implemented Interfaces:

IMCMethod

public class MCMethod
extends Object
implements IMCMethod

Base implementation of the IMCMethod interface.

Methods in this class should not be overridden. If you want to override anything, then implement the IMCMethod interface instead and optionally delegate calls to this class.

Please do not add utility methods to this class. Use the helper class MethodToolkit if you want to do common utility stuff.

Constructor Summary

Constructors

Constructor	Description
MCMethod(IMCType type, String methodName, String formalDescriptor, Integer modifier, Boolean isNative)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
final String	getFormalDescriptor()	Returns the formal descriptor.
final String	getMethodName()	Returns the method name not including parameters.
final Integer	getModifier()	Returns the modifier used in the Java class file.
final IMCType	getType()	Returns the class this method is declared in.
int	hashCode()
final Boolean	isHidden()	Whether this method is hidden.
final Boolean	isNative()	Whether this method is native.

Methods inherited from class java.lang.Object

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

Constructor Details

MCMethod

public MCMethod(IMCType type,
 String methodName,
 String formalDescriptor,
 Integer modifier,
 Boolean isNative)

Create a new instance.

Parameters:

type - the class that this method is declared in

methodName - the method name

formalDescriptor - the formal descriptor, see IMCMethod.getFormalDescriptor()

modifier - method modifier bit pattern, see IMCMethod.getModifier()

isNative - whether the method is native, see IMCMethod.isNative()

Method Details

getType

public final IMCType getType()

Description copied from interface: IMCMethod

Returns the class this method is declared in.

Specified by:

getType in interface IMCMethod

Returns:

the class declaring this method

getMethodName

public final String getMethodName()

Description copied from interface: IMCMethod

Returns the method name not including parameters.

An example is "mymethod". If the method is native the format is undefined.

Specified by:

getMethodName in interface IMCMethod

Returns:

the name of this method, or null if unavailable

getFormalDescriptor

public final String getFormalDescriptor()

Description copied from interface: IMCMethod

Returns the formal descriptor.

For example, the method descriptor for the method Object mymethod(int i, double d, Thread t) is (IDLjava/lang/Thread;)Ljava/lang/Object;

Specified by:

getFormalDescriptor in interface IMCMethod

Returns:

the formal method descriptor, or null if unavailable

getModifier

public final Integer getModifier()

Description copied from interface: IMCMethod

Returns the modifier used in the Java class file.

Examples of modifiers are "protected", "public", etc.

See Modifier for more information about the bit pattern and for methods that can be used to decode it.

Specified by:

getModifier in interface IMCMethod

Returns:

the modifier used in the class file, or null if not available

isNative

public final Boolean isNative()

Description copied from interface: IMCMethod

Whether this method is native.

Specified by:

isNative in interface IMCMethod

Returns:

Boolean.TRUE if the method is native, Boolean.FALSE if not, or null if the information is not available

isHidden

public final Boolean isHidden()

Description copied from interface: IMCMethod

Whether this method is hidden.

Specified by:

isHidden in interface IMCMethod

Returns:

Boolean.TRUE if the method is hidden, Boolean.FALSE if not, or null if the information is not available

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object