com.sun.n1.sps.model.component
Interface VarDecl

public interface VarDecl

This interface defines a variable declaration for a specific component.

For abstract variables, the default value is null. Abstract variables may only be contained in abstract components, which serves only as a base component for other components to extend.

Method Summary

java.lang.String	getDefaultValue() Returns the default value of the variable or null if this component is abstract.
Modifier	getModifier() Returns the modifier for the variable.
java.lang.String	getName() Returns the name of the variable.
java.lang.String	getPrompt() Returns An optional string that is a user-readable description of the variable.

Method Detail

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value of the variable or null if this component is abstract. The result may include references to substitution variables.

Returns:

The default value of the variable.

getModifier

Modifier getModifier()

Returns the modifier for the variable.

Returns:

The variable's modifier.

getName

java.lang.String getName()

Returns the name of the variable.

Returns:

The name of the variable.

getPrompt

java.lang.String getPrompt()

Returns An optional string that is a user-readable description of the variable.

Returns:

The prompt for the variable.