net.sourceforge.ccxjc.it.model.pkg.collections.novalueclass.javaee
Interface VariableType

All Known Implementing Classes:
VariableTypeImpl

public interface VariableType

The variableType provides information on the scripting variables defined by using this tag. It is a (translation time) error for a tag that has one or more variable subelements to have a TagExtraInfo class that returns a non-null value from a call to getVariableInfo(). The subelements of variableType are of the form: description Optional description of this variable name-given The variable name as a constant name-from-attribute The name of an attribute whose (translation time) value will give the name of the variable. One of name-given or name-from-attribute is required. variable-class Name of the class of the variable. java.lang.String is default. declare Whether the variable is declared or not. True is the default. scope The scope of the scripting varaible defined. NESTED is default.

Java class for variableType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="variableType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/javaee}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <choice>
           <element name="name-given" type="{http://java.sun.com/xml/ns/javaee}java-identifierType"/>
           <element name="name-from-attribute" type="{http://java.sun.com/xml/ns/javaee}java-identifierType"/>
         </choice>
         <element name="variable-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType" minOccurs="0"/>
         <element name="declare" type="{http://java.sun.com/xml/ns/javaee}generic-booleanType" minOccurs="0"/>
         <element name="scope" type="{http://java.sun.com/xml/ns/javaee}variable-scopeType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Method Summary
 GenericBooleanType getDeclare()
          Gets the value of the declare property.
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 String getId()
          Gets the value of the id property.
 JavaIdentifierType getNameFromAttribute()
          Gets the value of the nameFromAttribute property.
 JavaIdentifierType getNameGiven()
          Gets the value of the nameGiven property.
 VariableScopeType getScope()
          Gets the value of the scope property.
 FullyQualifiedClassType getVariableClass()
          Gets the value of the variableClass property.
 void setDeclare(GenericBooleanType value)
          Sets the value of the declare property.
 void setId(String value)
          Sets the value of the id property.
 void setNameFromAttribute(JavaIdentifierType value)
          Sets the value of the nameFromAttribute property.
 void setNameGiven(JavaIdentifierType value)
          Sets the value of the nameGiven property.
 void setScope(VariableScopeType value)
          Sets the value of the scope property.
 void setVariableClass(FullyQualifiedClassType value)
          Sets the value of the variableClass property.
 

Method Detail

getDescription

List<DescriptionType> getDescription()
Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType


getNameGiven

JavaIdentifierType getNameGiven()
Gets the value of the nameGiven property.

Returns:
possible object is JavaIdentifierType

setNameGiven

void setNameGiven(JavaIdentifierType value)
Sets the value of the nameGiven property.

Parameters:
value - allowed object is JavaIdentifierType

getNameFromAttribute

JavaIdentifierType getNameFromAttribute()
Gets the value of the nameFromAttribute property.

Returns:
possible object is JavaIdentifierType

setNameFromAttribute

void setNameFromAttribute(JavaIdentifierType value)
Sets the value of the nameFromAttribute property.

Parameters:
value - allowed object is JavaIdentifierType

getVariableClass

FullyQualifiedClassType getVariableClass()
Gets the value of the variableClass property.

Returns:
possible object is FullyQualifiedClassType

setVariableClass

void setVariableClass(FullyQualifiedClassType value)
Sets the value of the variableClass property.

Parameters:
value - allowed object is FullyQualifiedClassType

getDeclare

GenericBooleanType getDeclare()
Gets the value of the declare property.

Returns:
possible object is GenericBooleanType

setDeclare

void setDeclare(GenericBooleanType value)
Sets the value of the declare property.

Parameters:
value - allowed object is GenericBooleanType

getScope

VariableScopeType getScope()
Gets the value of the scope property.

Returns:
possible object is VariableScopeType

setScope

void setScope(VariableScopeType value)
Sets the value of the scope property.

Parameters:
value - allowed object is VariableScopeType

getId

String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String


Copyright © 2009 The CC-XJC Community. All Rights Reserved.