wt.tools.xref
Class Method

java.lang.Object
  wt.tools.xref.Method

All Implemented Interfaces:

WriteHtmlInterface

public class Method

extends Object

implements WriteHtmlInterface

This class is used to store all information pertaining to a method in the system. This include things like: 1. class references made using the instanceof operator 2. classes instantiated 3. names of method's called from this method 4. names of methods that call this method 5. names of fields from other classes referenced by this method

Field Summary

private String[]	d_argTypes
private String	d_className
private String	d_methodName
private int	d_methodNumber
private ClassInterface	d_owner
private String	d_packageClassSpec
private String	d_packageName
private String	d_returnType

Constructor Summary

Method(ClassInterface owner, com.ibm.toad.cfparse.MethodInfo mi)
This constructor is used to automatically construct a Method object from a MethodInfo object.

Method(ClassInterface owner, String returnType, String className, String methodName, String[] argTypes)

Method Summary

String[]	getArgTypes() This method returns a reference to the d_argTypes array.
String	getClassName() This method returns a reference to the d_packageClassSpec field.
(package private) int	getMethodNumber()
String	getName()
String	getReturnType() This method returns a reference to the d_returnType field.
String	methodSignature(boolean includeClassName) This method produces a full method signature for this Method instance.
(package private) void	setMethodNumber(int number)
String	toFileName() This method constructs a unique fileName based on the method name and the argument list.
String	toHrefDisplayString() This method implements the WriteHtmlInterface.
String	toString() This method returns the full method signature of this method

Methods inherited from class java.lang.Object

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

Field Detail

d_owner

private ClassInterface d_owner

d_returnType

private String d_returnType

d_packageClassSpec

private String d_packageClassSpec

d_packageName

private String d_packageName

d_className

private String d_className

d_methodName

private String d_methodName

d_argTypes

private String[] d_argTypes

d_methodNumber

private int d_methodNumber

Constructor Detail

Method

public Method(ClassInterface owner,
              com.ibm.toad.cfparse.MethodInfo mi)

This constructor is used to automatically construct a Method object from a MethodInfo object.

Method

public Method(ClassInterface owner,
              String returnType,
              String className,
              String methodName,
              String[] argTypes)

Method Detail

setMethodNumber

void setMethodNumber(int number)

getMethodNumber

int getMethodNumber()

getReturnType

public String getReturnType()

This method returns a reference to the d_returnType field.

getClassName

public String getClassName()

This method returns a reference to the d_packageClassSpec field.

getName

public String getName()

getArgTypes

public String[] getArgTypes()

This method returns a reference to the d_argTypes array.

toString

public String toString()

This method returns the full method signature of this method

methodSignature

public String methodSignature(boolean includeClassName)

This method produces a full method signature for this Method instance. This signature is of the form: returnType classSpec.methodSpec(argTypeList) where returnType = packageName.className classSpec = packageName.className methodSpec = methodName argTypeList = 0 or more of either packageName.className OR Java base data types.

toFileName

public String toFileName()

This method constructs a unique fileName based on the method name and the argument list. This method implements the WriteHtmlInterface

Specified by:

toFileName in interface WriteHtmlInterface

toHrefDisplayString

public String toHrefDisplayString()

This method implements the WriteHtmlInterface.

Specified by:

toHrefDisplayString in interface WriteHtmlInterface