jde.wizards.Signature Class Reference

List of all members.

Public Member Functions
	Signature (Method meth, ClassRegistry aregistry)
	Signature (Method meth, ClassRegistry aregistry, boolean truncate)
void	setTruncating (boolean b)
void	setRegistry (ClassRegistry registry)
Class	getDeclaringClass ()
String	toJavaDoc ()
String	toString ()
boolean	paramsEqual (Class[] p)
boolean	equals (Object compare)
Method	getMethod ()
final String	baseName (Class type)
final String	getParameters (Class[] params)

---

Detailed Description

Defines a method signature.

Author:

Eric D. Friedman

Version:

Revision:

1.26

---

Constructor & Destructor Documentation

jde.wizards.Signature.Signature	(	Method	meth,
		ClassRegistry	aregistry
	)

Creates a signature for the specified method and register its types with the specified registry (which may be null). Removes package info from generated signatures.

Parameters:

	meth	Method represented by this signature
	aregistry	Registry containing this signature

jde.wizards.Signature.Signature	(	Method	meth,
		ClassRegistry	aregistry,
		boolean	truncate
	)

Creates a signature for the specified method and register its types with the specified registry (which may be null).

Parameters:

	meth	Method represented by thi signature
	aregistry	Registry containing this signature
	truncate	toggles removal of package info from generated signatures

---

Member Function Documentation

final String jde.wizards.Signature.baseName

(

Class

type

)

Computes the basename of the specified class. This returns "Object" from "java.lang.Object." It returns the "single" form of an Array object.

Parameters:

type

Class whose basename is required

Returns:

basename

Referenced by jde.wizards.Signature.getParameters(), and jde.wizards.Signature.toString().

boolean jde.wizards.Signature.equals

(

Object

compare

)

Tests whether a given object equals this signature. The object is considered equal if it is a signature and it has the same method name and parameter list.

Parameters:

compare

Test object

Returns:

true if the test object equals this signature.

References jde.wizards.Signature.getMethod(), and jde.wizards.Signature.paramsEqual().

Referenced by jde.wizards.MethodOverrideFactory.getCandidateSignatures(), jde.wizards.Signature.paramsEqual(), and jde.wizards.Signature.toJavaDoc().

Class jde.wizards.Signature.getDeclaringClass

(

)

Gets the class that declared the method represented by this signature.

Returns:

The class this method was declared in

Method jde.wizards.Signature.getMethod

(

)

Gets the method of which this is a signature.

Returns:

Method of which this is a signature.

Referenced by jde.wizards.Signature.equals(), jde.wizards.MethodOverrideFactory.getCandidateSignatures(), jde.wizards.MethodOverrideFactory.getMethodSkeleton(), and jde.wizards.MethodFactory.getMethodSkeleton().

final String jde.wizards.Signature.getParameters

(

Class[]

params

)

Gets a parameter list for this method; parameters are named by the NameFactory whose default implementation uses param1 .. paramn

Parameters:

params

Parameters of this method

Returns:

Parameter list in string form

References jde.wizards.Signature.baseName(), jde.wizards.ClassRegistry.getNameFactory(), and jde.wizards.NameFactory.getParameterName().

Referenced by jde.wizards.MethodOverrideFactory.getCandidateSignatures(), and jde.wizards.Signature.toString().

boolean jde.wizards.Signature.paramsEqual

(

Class[]

p

)

References jde.wizards.Signature.equals().

Referenced by jde.wizards.Signature.equals().

void jde.wizards.Signature.setRegistry

(

ClassRegistry

registry

)

Sets the registry used to register this signature's types.

Parameters:

registry

Registry used to register this signature's type.

void jde.wizards.Signature.setTruncating

(

boolean

b

)

Toggles truncation of package info .

Parameters:

b

Truncation toggle

String jde.wizards.Signature.toJavaDoc

(

)

Generates a javadoc string for this signature.

Returns:

A javadoc for this method

References jde.wizards.Signature.equals(), jde.wizards.ClassRegistry.getNameFactory(), and jde.wizards.NameFactory.getParameterName().

Referenced by jde.wizards.MethodFactory.getMethodSkeleton().

String jde.wizards.Signature.toString

(

)

Gets the signature as a string.

Returns:

Signature of this method.

References jde.wizards.Signature.baseName(), and jde.wizards.Signature.getParameters().

---

The documentation for this class was generated from the following file:

• Signature.java