Attributes for the <var> Element

The <var> element has the following attributes:

• access – An optional value of type accessEnum, which specifies the accessibility of the variable. This attribute can have one of the following values:

  • PUBLIC – Access is not restricted in any way, which is the default.

  • PROTECTED – Access is limited to derived components and entities that are in the same path.

  • PATH – Access is limited to entities that are in the same path.

  • PRIVATE – Access is limited to this component.

• modifier – An optional value of type modifierEnum, which specifies the override requirements for the variable. This attribute can have the following values:

  • ABSTRACT – The variable's default attribute is omitted and must be specified by a variable in nonabstract derived components. Variables can only be declared as abstract if the component is also declared as abstract. Abstract variables cannot be private. Nonabstract variables must declare a default value.

  • FINAL – The variable cannot be overridden by derived components.

  If the attribute is omitted, derived components can choose whether to override the variable.

• name – A required value of type identifier, which is the name of the substitution variable. Each variable name declared by a <var> element in the <varList> element must be unique.

• default – A required string for nonabstract variables, which is the default value of the substitution variable. This value can include references to other substitution variables, session variables, target host attributes, and installed component variables. However, an abstract variable cannot define a default value, so this attribute cannot be used for abstract variables.

• prompt – An optional string that is a user-readable description of the variable.