com.sun.tools.javadoc
Class ParameterImpl

java.lang.Object
  com.sun.tools.javadoc.ParameterImpl

All Implemented Interfaces:

Parameter

 class ParameterImpl
extends java.lang.Object
implements Parameter

ParameterImpl information. This includes a parameter type and parameter name.

Field Summary

private DocEnv	env
private Symbol.VarSymbol	sym
private Type	type

Constructor Summary

ParameterImpl(DocEnv env, Symbol.VarSymbol sym)
Constructor of parameter info class.

Method Summary

AnnotationDesc[]	annotations() Get the annotations of this parameter.
java.lang.String	name() Get local name of this parameter.
java.lang.String	toString() Returns a string representation of the parameter.
Type	type() Get the type of this parameter.
java.lang.String	typeName() Get type name of this parameter.

Methods inherited from class java.lang.Object

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

Field Detail

env

private final DocEnv env

sym

private final Symbol.VarSymbol sym

type

private final Type type

Constructor Detail

ParameterImpl

ParameterImpl(DocEnv env,
              Symbol.VarSymbol sym)

Constructor of parameter info class.

Method Detail

type

public Type type()

Get the type of this parameter.

Specified by:

type in interface Parameter

name

public java.lang.String name()

Get local name of this parameter. For example if parameter is the short 'index', returns "index".

Specified by:

name in interface Parameter

typeName

public java.lang.String typeName()

Get type name of this parameter. For example if parameter is the short 'index', returns "short".

Specified by:

typeName in interface Parameter

toString

public java.lang.String toString()

Returns a string representation of the parameter.

For example if parameter is the short 'index', returns "short index".

Specified by:

toString in interface Parameter

Overrides:

toString in class java.lang.Object

Returns:

type name and parameter name of this parameter.

annotations

public AnnotationDesc[] annotations()

Get the annotations of this parameter. Return an empty array if there are none.

Specified by:

annotations in interface Parameter

Returns:

the annotations of this parameter.