uk.co.badgersinfoil.metaas.dom
Interface ASArg

All Superinterfaces:

ScriptElement

public interface ASArg
extends ScriptElement

A parameter in a method or function definition.

See Also:

FunctionCommon.addParam(String, String), FunctionCommon.getArgs()

Method Summary

java.lang.String	getDefaultString() Returns a String representation of the default value for the argument (if no value is provided by the calling code), or null if there is no default.
java.lang.String	getDescriptionString() Returns the description of this parameter from the documentation comment attached to the enclosing method, or null, if there is no such comment, or it lacks a @param paragraph with a name matching this parameter.
java.lang.String	getName() Returns the name of this ActionScript method argument
java.lang.String	getType() Returns the name of this parameter's type, or null if the parameter is untyped.
boolean	isRest() Returns true if this is a 'rest' parameter; an array that will hold remaning arguments passed after the other formal arguments.
void	setDefault(java.lang.String string) Specifies the compile-time-constant value that will be the default for the argument if no value is provided by the calling code.
void	setDescription(java.lang.String description) Defines the descriptive text for for this parameter in the documentation comment attached to the enclosing method.
void	setType(java.lang.String string) Defines the name of the type of object this parameter may reference.

Method Detail

getName

java.lang.String getName()

Returns the name of this ActionScript method argument

getType

java.lang.String getType()

Returns the name of this parameter's type, or null if the parameter is untyped.

setType

void setType(java.lang.String string)

Defines the name of the type of object this parameter may reference. May be set to null, denoting that the value is untyped.

setDefault

void setDefault(java.lang.String string)

Specifies the compile-time-constant value that will be the default for the argument if no value is provided by the calling code.

getDefaultString

java.lang.String getDefaultString()

Returns a String representation of the default value for the argument (if no value is provided by the calling code), or null if there is no default.

See Also:

setDefault(String)

isRest

boolean isRest()

Returns true if this is a 'rest' parameter; an array that will hold remaning arguments passed after the other formal arguments. A 'rest' argument should always be the last one declared in the parameter list of a function or method.

getDescriptionString

java.lang.String getDescriptionString()

Returns the description of this parameter from the documentation comment attached to the enclosing method, or null, if there is no such comment, or it lacks a @param paragraph with a name matching this parameter.

setDescription

void setDescription(java.lang.String description)

Defines the descriptive text for for this parameter in the documentation comment attached to the enclosing method. If null is given, any descriptive @param paragraph with a name matching this parameter will be removed from the method's documentation.

Throws:

SyntaxException - if the given text contains an end-of-comment marker, or appears to include another tagged paragraph

See Also:

DocComment