ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaModule

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

public abstract class CoalaModule
extends CoalaElement
implements CoopnSyntacticModule

Coala module.

See Also:
CoalaElement, Serialized Form

Field Summary
static int CAA
           
 
Constructor Summary
protected CoalaModule(CoopnCompilInfo info, CoopnCompilInfo coopnInfo, java.lang.String[] deps, int kind, CoalaHeader header)
          Simple constructor.
protected CoalaModule(CoopnCompilInfo info, CoopnCompilInfo coopnInfo, java.lang.String[] deps, int kind, CoalaHeader header, java.lang.String comment)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning method.
 java.lang.String comment()
          Comment retrieving method.
 CoopnCompilInfo compilInfo()
          Return the compilation information associated to this module.
 CoopnCompilInfo coopnInfo()
           
 java.lang.String[] dependencies()
           
 boolean equals(java.lang.Object obj)
          Equality method.
 int hashCode()
          Hashcode method.
 boolean hasParameters()
          Look if this module has parameters,i.e. additional information to the complete kind.
 CoalaHeader header()
           
 CoopnCompilInfo info()
           
abstract  java.lang.String kind()
          Kind retrieving method.
 int mkind()
           
 int moduleKind()
          Get the module kind (in the sense of the package manager) of this module, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
 java.lang.String parameters()
          Parameters retrieving method.
abstract  CoopnSyntacticSection[] sections()
          Get the sections of this module.
 void useDependencies(java.lang.String[] deps)
           
static boolean validKind(int kind)
           
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
cloneCoalaElement, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteText, toCompleteText, toString, toString, toString, toText
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticModule
completeKind, moduleName
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Field Detail

CAA

public static final int CAA
Constructor Detail

CoalaModule

protected CoalaModule(CoopnCompilInfo info,
                      CoopnCompilInfo coopnInfo,
                      java.lang.String[] deps,
                      int kind,
                      CoalaHeader header)
Simple constructor.

CoalaModule

protected CoalaModule(CoopnCompilInfo info,
                      CoopnCompilInfo coopnInfo,
                      java.lang.String[] deps,
                      int kind,
                      CoalaHeader header,
                      java.lang.String comment)
Simple constructor.
Method Detail

validKind

public static boolean validKind(int kind)

mkind

public int mkind()

useDependencies

public void useDependencies(java.lang.String[] deps)

comment

public java.lang.String comment()
Description copied from interface: CoopnSyntacticModule
Comment retrieving method. This method must be defined in the inherited classes for returning the comment associated to this symbol.
Specified by:
comment in interface CoopnSyntacticModule
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticModule
Returns:
a string defining the associated comment, or null iff no comment is associated to this symbol.

moduleKind

public int moduleKind()
Get the module kind (in the sense of the package manager) of this module, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
Specified by:
moduleKind in interface CoopnSyntacticModule
Returns:
the module kind.

kind

public abstract 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".
Specified by:
kind in interface CoopnSyntacticModule
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticModule
Returns:
a string defining the module kind.

sections

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

hasParameters

public boolean hasParameters()
Look if this module has parameters,i.e. additional information to the complete kind.
Specified by:
hasParameters in interface CoopnSyntacticModule
Returns:
boolean iff this module has parameters.

parameters

public java.lang.String parameters()
Parameters retrieving method. Parameters are additional information to the complete kind.
Specified by:
parameters in interface CoopnSyntacticModule
Returns:
a string defining the paremeters, or null.

header

public CoalaHeader header()

compilInfo

public CoopnCompilInfo compilInfo()
Description copied from interface: CoopnSyntacticModule
Return the compilation information associated to this module.
Specified by:
compilInfo in interface CoopnSyntacticModule

info

public CoopnCompilInfo info()

coopnInfo

public CoopnCompilInfo coopnInfo()

dependencies

public java.lang.String[] dependencies()

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.

hashCode

public int hashCode()
Description copied from interface: CoopnSyntacticElement
Hashcode method. Must be defined in the inherited classes.
Specified by:
hashCode in interface CoopnSyntacticElement
Overrides:
hashCode in class CoalaElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
the hash code.

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.