xjavadoc

Class ParameterImpl

Implemented Interfaces:
Named, Type, XParameter

public final class ParameterImpl
extends AbstractType
implements XParameter

This is a flyweight implementation of XParameter
Version:
$Revision: 1.18 $
Authors:
Ara Abrahamian (ara_e_w@yahoo.com)
Aslak Helles?y

Field Summary

private AbstractExecutableMember
_containingExecutableMember
XMember we're currently reresenting.
private String
_description
private int
_parameterIndex
Index of the parameter we're currently representing.
static int
instanceCount

Constructor Summary

ParameterImpl()

Method Summary

String
getDescription()
Gets the description of this parameter.
int
getDimension()
Returns the dimension as an int
String
getDimensionAsString()
Returns the dimension as a String, "", "[]", "[][]" etc.
String
getName()
Get name
XTag
getParamTag()
Gets the param tag for this parameter.
XClass
getType()
Returns the class describing the type of this parameter.
(package private) void
setState(AbstractExecutableMember containingExecutableMember, int parameterIndex)
Sets the extrinsic flyweight state.
String
toString()

Methods inherited from class xjavadoc.AbstractType

equals

Field Details

_containingExecutableMember

private AbstractExecutableMember _containingExecutableMember
XMember we're currently reresenting.

_description

private String _description

_parameterIndex

private int _parameterIndex
Index of the parameter we're currently representing.

instanceCount

public static int instanceCount

Constructor Details

ParameterImpl

public ParameterImpl()

Method Details

getDescription

public String getDescription()
Gets the description of this parameter. This is the text in the param tag preceding the first token.
Specified by:
getDescription in interface XParameter
Returns:
the description of this parameter, or null if there is no corresponding param tag.

getDimension

public final int getDimension()
Returns the dimension as an int
Specified by:
getDimension in interface Type
Returns:
dimension as an int

getDimensionAsString

public String getDimensionAsString()
Returns the dimension as a String, "", "[]", "[][]" etc.
Specified by:
getDimensionAsString in interface Type
Returns:
dimension as a String

getName

public final String getName()
Get name
Specified by:
getName in interface Named
Returns:
name

getParamTag

public XTag getParamTag()
Gets the param tag for this parameter.
Specified by:
getParamTag in interface XParameter
Returns:
the param tag for this parameter, or null if none is specified.

getType

public final XClass getType()
Returns the class describing the type of this parameter.
Specified by:
getType in interface Type
Returns:

setState

(package private) final void setState(AbstractExecutableMember containingExecutableMember,
                                      int parameterIndex)
Sets the extrinsic flyweight state.
Parameters:
containingExecutableMember - The containing member
parameterIndex -

toString

public final String toString()