org.multijava.mjdoc.mjdoc_142
Class MjParameter

java.lang.Object
  org.multijava.mjdoc.mjdoc_142.MjParameter

All Implemented Interfaces:

com.sun.javadoc.Parameter

public class MjParameter

extends Object

implements com.sun.javadoc.Parameter

The class implements the javadoc Parameter interface, and wraps the name and type of a MJC formal parameter to supply the information about the parameter to javadoc.

Author:

David R. Cok

Field Summary
private  String	modString
private  String	name           The formal variable identifier.
private  MjType	type           The type of the formal parameter.

 

Constructor Summary

MjParameter(CSpecializedType cst, String name)           Constructs a javadoc Parameter object from a MJC CSpecializedType object (from a CMethod object) and a formal parameter identifier.

MjParameter(JFormalParameter jfp)           Constructs a javadoc Parameter object from a MJC CType object and formal parameter identifier.

 

Method Summary
String	modString()           Returns any special modifiers of the parameter as a String.
String	name()           Returns the identifier of the formal parameter.
String	toString()           Returns the fully-qualified type name, with dimensions, followed by a space and the formal identifier.
com.sun.javadoc.Type	type()           Returns the type of the formal parameter (as a MjType object).
String	typeName()           Returns the fully-qualified type name, with dimension information.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

type

private MjType type

The type of the formal parameter.

name

private String name

The formal variable identifier.

modString

private String modString

MjParameter

public MjParameter(CSpecializedType cst,
                   String name)

Constructs a javadoc Parameter object from a MJC CSpecializedType object (from a CMethod object) and a formal parameter identifier.

MjParameter

public MjParameter(JFormalParameter jfp)

Constructs a javadoc Parameter object from a MJC CType object and formal parameter identifier.

name

public String name()

Returns the identifier of the formal parameter.

Specified by:

name in interface com.sun.javadoc.Parameter

toString

public String toString()

Returns the fully-qualified type name, with dimensions, followed by a space and the formal identifier.

Specified by:

toString in interface com.sun.javadoc.Parameter

Overrides:

toString in class Object

modString

public String modString()

Returns any special modifiers of the parameter as a String.

type

public com.sun.javadoc.Type type()

Returns the type of the formal parameter (as a MjType object).

Specified by:

type in interface com.sun.javadoc.Parameter

typeName

public String typeName()

Returns the fully-qualified type name, with dimension information.

Specified by:

typeName in interface com.sun.javadoc.Parameter