com.whitestein.lsps.lang.signature

Class SignatureParameter

java.lang.Object

com.whitestein.lsps.lang.signature.SignatureParameter

public class SignatureParameter
extends Object

Information about a parameter in function or closure signature.

Author:

pna, vbu

Constructor Summary

Constructors

Constructor and Description
SignatureParameter(SignatureParameter param) Creates a new signature parameter from a given one.
SignatureParameter(Type type) Creates a new unnamed signature parameter.
SignatureParameter(Type type, boolean variadic) Creates a new unnamed signature parameter.
SignatureParameter(Type type, String name) Creates a new signature parameter.
SignatureParameter(Type type, String name, boolean variadic, boolean isRequired, String defaultValue) Creates a new signature parameter.

Method Summary

Modifier and Type	Method and Description
Expression	getDefaultValueExpression(NamespaceModel namespaceModel) Returns the parsed default value expression.
String	getDefaultValueExpressionText() Returns the text of default value expression.
String	getName() Returns the name of this parameter.
Type	getType() Returns type of this parameter
boolean	isOptional() Returns true if the parameter is optional.
boolean	isRequired() Returns true if the parameter is required.
boolean	isVariadic() Returns true if this parameter is variadic, false otherwise.
String	toString() Returns string representation of this signature parameter in the form #paramType #paramName?.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureParameter

public SignatureParameter(Type type)

Creates a new unnamed signature parameter.

Parameters:

type - type of parameter

SignatureParameter

public SignatureParameter(Type type,
                          boolean variadic)

Creates a new unnamed signature parameter.

Parameters:

type - type of parameter

variadic - boolean specifying if this parameter is variadic

SignatureParameter

public SignatureParameter(Type type,
                          String name)

Creates a new signature parameter. The parameter is not variadic; to create a variadic parameter, use constructor SignatureParameter(Type, String, boolean, boolean, String).

Parameters:

type - type of parameter

name - string containing name of parameter

SignatureParameter

public SignatureParameter(Type type,
                          String name,
                          boolean variadic,
                          boolean isRequired,
                          String defaultValue)

Creates a new signature parameter.

Parameters:

type - a parameter type

name - a parameter name

variadic - a flag specifying whether this parameter is variadic

isRequired - a flag specifying whether this parameter is required

defaultValue - a default value expression source

SignatureParameter

public SignatureParameter(SignatureParameter param)

Creates a new signature parameter from a given one.

Parameters:

param -

Method Detail

getName

public String getName()

Returns the name of this parameter.

Returns:

string containing name of parameter

getType

public Type getType()

Returns type of this parameter

Returns:

type of the parameter

isVariadic

public boolean isVariadic()

Returns true if this parameter is variadic, false otherwise.

Returns:

true if the parameter is variadic, false otherwise

isRequired

public boolean isRequired()

Returns true if the parameter is required.

Returns:

true if the parameter is required

isOptional

public boolean isOptional()

Returns true if the parameter is optional.

Returns:

true if the parameter is optional

toString

public String toString()

Returns string representation of this signature parameter in the form #paramType #paramName?.

Overrides:

toString in class Object

See Also:

Object.toString()

getDefaultValueExpression

public Expression getDefaultValueExpression(NamespaceModel namespaceModel)

Returns the parsed default value expression.

Parameters:

namespaceModel - the signature namespace model

Returns:

the default value expression

getDefaultValueExpressionText

public String getDefaultValueExpressionText()

Returns the text of default value expression.

Returns:

the text of default value expression