ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaCaaModule

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
        |
        +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaModule
              |
              +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaCaaModule
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticModule, java.io.Serializable

public class CoalaCaaModule
extends CoalaModule

Coala ADT module.

See Also:
CoalaElement, Serialized Form

Fields inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaModule
CAA
 
Constructor Summary
CoalaCaaModule(CoopnCompilInfo info, CoopnCompilInfo coopnInfo, java.lang.String[] deps, CoalaHeader header, CoalaCaaInterface inter, CoalaCaaBody body)
          Simple constructor.
CoalaCaaModule(CoopnCompilInfo info, CoopnCompilInfo coopnInfo, java.lang.String[] deps, CoalaHeader header, CoalaCaaInterface inter, CoalaCaaBody body, java.lang.String comment)
          Simple constructor.
 
Method Summary
 CoalaCaaBody body()
           
 java.lang.Object clone()
          Cloning method.
 java.lang.String completeKind()
          Complete kind retrieving method.
 boolean equals(java.lang.Object obj)
          Equality method.
 boolean hasBody()
           
 boolean hasInterface()
           
 CoalaCaaInterface inter()
           
 java.lang.String kind()
          Kind retrieving method.
 java.lang.String moduleName()
          Get the name.
 CoopnSyntacticSection[] sections()
          Get the sections of this module.
 void setBody(CoalaCaaBody body)
           
 void setInterface(CoalaCaaInterface inter)
           
 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.
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaModule
comment, compilInfo, coopnInfo, dependencies, hashCode, hasParameters, header, info, mkind, moduleKind, parameters, useDependencies, validKind
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
cloneCoalaElement, 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.CoopnSyntacticElement
toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Constructor Detail

CoalaCaaModule

public CoalaCaaModule(CoopnCompilInfo info,
                      CoopnCompilInfo coopnInfo,
                      java.lang.String[] deps,
                      CoalaHeader header,
                      CoalaCaaInterface inter,
                      CoalaCaaBody body)
Simple constructor.

CoalaCaaModule

public CoalaCaaModule(CoopnCompilInfo info,
                      CoopnCompilInfo coopnInfo,
                      java.lang.String[] deps,
                      CoalaHeader header,
                      CoalaCaaInterface inter,
                      CoalaCaaBody body,
                      java.lang.String comment)
Simple constructor.
Method Detail

kind

public java.lang.String kind()
Description copied from interface: CoopnSyntacticModule
Kind retrieving method. This method must be defined in the inherited classes for returning a string allowing the user to know what kind of module this is, for instance "Class", "Aspect", or "CAA".
Overrides:
kind in class CoalaModule
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticModule
Returns:
a string defining the module kind.

moduleName

public java.lang.String moduleName()
Description copied from interface: CoopnSyntacticModule
Get the name. Must be defined in the inherited classes.
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticModule
Returns:
a String representation of the module name. Never null.

sections

public CoopnSyntacticSection[] sections()
Description copied from interface: CoopnSyntacticModule
Get the sections of this module.
Overrides:
sections in class CoalaModule
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticModule
Returns:
The sections defined by this module.

setInterface

public void setInterface(CoalaCaaInterface inter)

setBody

public void setBody(CoalaCaaBody body)

inter

public CoalaCaaInterface inter()

body

public CoalaCaaBody body()

hasInterface

public boolean hasInterface()

hasBody

public boolean hasBody()

completeKind

public java.lang.String completeKind()
Complete kind retrieving method. This method must be defined in the inherited classes for returning a string allowing the user to know what kind of module this is, including building information such as "generic" or "abstract".
Returns:
a string defining the module complete kind.

equals

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

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.
Overrides:
clone in class CoalaModule
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
a clone object.