ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaUseCaaSymbol

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

public class CoalaUseCaaSymbol
extends CoalaSymbol
implements CoopnSyntacticUseSymbol, CoopnModuleDependency

Coala CAA use.

See Also:
CoalaElement, Serialized Form

Constructor Summary
CoalaUseCaaSymbol(CoalaName name, CoalaModuleName module, CoalaModuleNameList moduleList)
          Simple constructor.
CoalaUseCaaSymbol(CoalaName name, CoalaModuleName module, CoalaModuleNameList moduleList, java.lang.String comment)
          Simple constructor.
CoalaUseCaaSymbol(CoalaName name, java.lang.String identifier, CoalaModuleName module, CoalaModuleNameList moduleList)
          Simple constructor.
CoalaUseCaaSymbol(CoalaName name, java.lang.String identifier, CoalaModuleName module, CoalaModuleNameList moduleList, java.lang.String comment)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning method.
 java.lang.String[] dependencies()
          Module dependency.
 boolean equals(java.lang.Object obj)
          Equality method.
 boolean equivalent(java.lang.Object obj)
          Equivalence testing method.
 java.lang.String kind()
          Kind retrieving method.
 CoalaModuleNameList modules()
           
 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.
 int usedModuleKind()
          Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
 java.lang.String[] uses()
          Get the use modules.
 
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

CoalaUseCaaSymbol

public CoalaUseCaaSymbol(CoalaName name,
                         java.lang.String identifier,
                         CoalaModuleName module,
                         CoalaModuleNameList moduleList)
                  throws java.lang.IllegalArgumentException
Simple constructor.

CoalaUseCaaSymbol

public CoalaUseCaaSymbol(CoalaName name,
                         CoalaModuleName module,
                         CoalaModuleNameList moduleList)
                  throws java.lang.IllegalArgumentException
Simple constructor.

CoalaUseCaaSymbol

public CoalaUseCaaSymbol(CoalaName name,
                         java.lang.String identifier,
                         CoalaModuleName module,
                         CoalaModuleNameList moduleList,
                         java.lang.String comment)
                  throws java.lang.IllegalArgumentException
Simple constructor.

CoalaUseCaaSymbol

public CoalaUseCaaSymbol(CoalaName name,
                         CoalaModuleName module,
                         CoalaModuleNameList moduleList,
                         java.lang.String comment)
                  throws java.lang.IllegalArgumentException
Simple constructor.
Method Detail

modules

public CoalaModuleNameList modules()

usedModuleKind

public int usedModuleKind()
Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
Specified by:
usedModuleKind in interface CoopnSyntacticUseSymbol

uses

public java.lang.String[] uses()
Description copied from interface: CoopnSyntacticUseSymbol
Get the use modules. Must be defined in the inherited classes.
Specified by:
uses in interface CoopnSyntacticUseSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticUseSymbol
Returns:
an array of String denoting the used modules.

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.

dependencies

public java.lang.String[] dependencies()
Description copied from interface: CoopnModuleDependency
Module dependency.
Specified by:
dependencies in interface CoopnModuleDependency
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnModuleDependency
Returns:
an array of strings containing names of modules.

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.