net.cscott.sinjdoc

Interface Parameter

public interface Parameter

The Parameter interface represents parameter information, including parameter type and parameter name.

Version: $Id: Parameter.java,v 1.5 2003/07/29 16:02:37 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.Parameter

Method Summary
abstract boolean	isVarArgs() Returns `true` if this is a "varargs" parameter.
abstract String	name() Return the local name of this parameter.
abstract Type	printableType() Return the "printable type" -- this is the component type of the type of a varargs parameter, otherwise it is the type of the parameter.
abstract String	toString() Return a human-readable string representing this parameter.
abstract Type	type() Return the type of this parameter.

Method Detail

public abstract boolean isVarArgs()

Returns true if this is a "varargs" parameter.

public abstract String name()

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

public abstract Type printableType()

Return the "printable type" -- this is the component type of the type of a varargs parameter, otherwise it is the type of the parameter.

public abstract String toString()

Return a human-readable string representing this parameter. For example, if this parameter is short index, returns "short index".

public abstract Type type()

Return the type of this parameter. For example, if this parameter is short index, then type().typeName() would be the string "short".