wt.tools.xref.specs
Class MethodSpec

java.lang.Object
  wt.tools.xref.specs.PackageSpec
      wt.tools.xref.specs.MethodSpec

All Implemented Interfaces:

Spec

public class MethodSpec

extends PackageSpec

Field Summary

private Spec[]	d_argTypeList
private String	d_classInterfaceName
private String	d_methodName
private int	d_methodNumber
private Spec	d_returnType

Fields inherited from class wt.tools.xref.specs.PackageSpec

Constructor Summary

MethodSpec(Spec returnType, ClassInterfaceSpec ciSpec, String methodName, Spec[] argTypeList)

Method Summary

Spec[]	getArgTypeList()
String	getArgTypeListString()
String	getClassInterfaceName()
String	getMethodName()
String	getPackageAndClassString()
Spec	getReturnType()
String	methodSignature(boolean includeClassName) This method produces a full method signature for this Method instance.
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	toSortString() This method is used in sorting containers of Spec objects.
String	toString()

Methods inherited from class wt.tools.xref.specs.PackageSpec

getPackageName

Methods inherited from class java.lang.Object

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

Field Detail

d_returnType

private Spec d_returnType

d_classInterfaceName

private String d_classInterfaceName

d_methodName

private String d_methodName

d_argTypeList

private Spec[] d_argTypeList

d_methodNumber

private int d_methodNumber

Constructor Detail

MethodSpec

public MethodSpec(Spec returnType,
                  ClassInterfaceSpec ciSpec,
                  String methodName,
                  Spec[] argTypeList)

Method Detail

setMethodNumber

public void setMethodNumber(int number)

getReturnType

public Spec getReturnType()

getClassInterfaceName

public String getClassInterfaceName()

getPackageAndClassString

public String getPackageAndClassString()

getMethodName

public String getMethodName()

getArgTypeList

public Spec[] getArgTypeList()

getArgTypeListString

public String getArgTypeListString()

toSortString

public String toSortString()

Description copied from interface: Spec

This method is used in sorting containers of Spec objects.

Specified by:

toSortString in interface Spec

Overrides:

toSortString in class PackageSpec

toString

public String toString()

Overrides:

toString in class PackageSpec

toFileName

public String toFileName()

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

toHrefDisplayString

public String toHrefDisplayString()

This method implements the WriteHtmlInterface.

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.