ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaVariableSymbol

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
        |
        +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSymbol
              |
              +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaVariableSymbol
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticParamSymbol, CoopnSyntacticSymbol, java.io.Serializable

public class CoalaVariableSymbol
extends CoalaSymbol
implements CoopnSyntacticParamSymbol

Coala CAA variable.

See Also:
CoalaElement, Serialized Form

Constructor Summary
CoalaVariableSymbol(CoalaName name, CoalaModuleName module, CoopnType type)
          Simple constructor.
CoalaVariableSymbol(CoalaName name, CoalaModuleName module, CoopnType type, java.lang.String comment)
          Simple constructor.
CoalaVariableSymbol(CoalaName name, java.lang.String identifier, CoalaModuleName module, CoopnType type)
          Simple constructor.
CoalaVariableSymbol(CoalaName name, java.lang.String identifier, CoalaModuleName module, CoopnType type, java.lang.String comment)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning method.
 boolean equals(java.lang.Object obj)
          Equality method.
 boolean equivalent(java.lang.Object obj)
          Equivalence testing method.
 java.lang.String kind()
          Kind retrieving method.
 CoopnSyntacticElement paramType()
          Get an element, representing the "type" (in a broad sense) of the parameter.
 ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toCompleteText(CoopnSymbolTable table)
          Complete textual elements conversion method.
 ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toText()
          Textual elements conversion method.
 CoopnType type()
          Return the type.
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSymbol
cloneCoalaElement, comment, equalsCoalaSymbol, equivalentCoalaSymbol, hashCode, identifier, module, name, symbolModule, symbolModuleKind, symbolName, toTextCoalaSymbol
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteText, toString, toString, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticSymbol
comment, identifier, symbolModule, symbolModuleKind, symbolName
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
hashCode, toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Constructor Detail

CoalaVariableSymbol

public CoalaVariableSymbol(CoalaName name,
                           java.lang.String identifier,
                           CoalaModuleName module,
                           CoopnType type)
                    throws java.lang.IllegalArgumentException
Simple constructor.

CoalaVariableSymbol

public CoalaVariableSymbol(CoalaName name,
                           CoalaModuleName module,
                           CoopnType type)
                    throws java.lang.IllegalArgumentException
Simple constructor.

CoalaVariableSymbol

public CoalaVariableSymbol(CoalaName name,
                           java.lang.String identifier,
                           CoalaModuleName module,
                           CoopnType type,
                           java.lang.String comment)
                    throws java.lang.IllegalArgumentException
Simple constructor.

CoalaVariableSymbol

public CoalaVariableSymbol(CoalaName name,
                           CoalaModuleName module,
                           CoopnType type,
                           java.lang.String comment)
                    throws java.lang.IllegalArgumentException
Simple constructor.
Method Detail

kind

public java.lang.String kind()
Description copied from interface: CoopnSyntacticSymbol
Kind retrieving method. This method must be defined in the inherited classes for returning a string allowing the user to know what kind of symbol this is.
Specified by:
kind in interface CoopnSyntacticSymbol
Overrides:
kind in class CoalaSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSymbol
Returns:
a string defining the symbol kind.

type

public CoopnType type()
Return the type.
Returns:
the type

paramType

public CoopnSyntacticElement paramType()
Get an element, representing the "type" (in a broad sense) of the parameter. More precisely, by "type", we intent the information added to the symbol name, characterising the parameter.
Specified by:
paramType in interface CoopnSyntacticParamSymbol
Returns:
the parameter "type".

equals

public boolean equals(java.lang.Object obj)
Description copied from interface: CoopnSyntacticElement
Equality method. Must be defined in the inherited classes.
Specified by:
equals in interface CoopnSyntacticElement
Overrides:
equals in class CoalaElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Parameters:
obj - the object to compare
Returns:
true iff this object and the parameter are equals.

equivalent

public boolean equivalent(java.lang.Object obj)
Description copied from class: CoalaSymbol
Equivalence testing method. This method must be defined in the inherited classes for returning a boolean deciding if this symbol is equivalent to the parameter. Two symbols are equivalents if they are equals, or if they are equals when source modules are not considered. For instance, transition "T" in "Module1" and transition "T" in "Module2" are are not equal, but are equivalent.
Overrides:
equivalent in class CoalaSymbol
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSymbol
Returns:
true iff both symbols are equivalents.

toText

public ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toText()
Description copied from class: CoalaElement
Textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a user-friendly textual element representing it. The string interpretation of this element is very intuitive by a user, but may be incorrect in the sense that it may be rejected by a checker.
Overrides:
toText in class CoalaElement
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
Returns:
a CoopnTextElement image.

toCompleteText

public ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toCompleteText(CoopnSymbolTable table)
Description copied from class: CoalaElement
Complete textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a correct textual element representing it. The string interpretation of this element will be accepted by a checker, but may be difficult to read by users, due to the additionnal information, like parenthesis and so on.
Overrides:
toCompleteText in class CoalaElement
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
Parameters:
table - the symbol table used to generate symbol references
Returns:
a CoopnTextElement image.

clone

public java.lang.Object clone()
Description copied from interface: CoopnSyntacticElement
Cloning method. Must be defined in the inherited classes.
Specified by:
clone in interface CoopnSyntacticElement
Overrides:
clone in class CoalaElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
a clone object.