ConForM.CoopnTools.CoKer
Interface CoopnSyntacticModule

All Superinterfaces:
java.lang.Cloneable, CoopnSyntacticElement, java.io.Serializable
All Known Implementing Classes:
CoalaModule, ConstraintsModule, CoopnModule, PackageModule, Scenario, SpecModule

public interface CoopnSyntacticModule
extends CoopnSyntacticElement

Coopn syntactic elements. This abstract class essentially defines basic synatctic elements of the various abstract syntaxes used by CoopnTools.


Method Summary
 java.lang.String comment()
          Comment retrieving method.
 CoopnCompilInfo compilInfo()
          Return the compilation information associated to this module.
 java.lang.String completeKind()
          Complete kind retrieving method.
 boolean hasParameters()
          Look if this module has parameters,i.e. additional information to the complete kind.
 java.lang.String kind()
          Kind retrieving method.
 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 moduleName()
          Get the name.
 java.lang.String parameters()
          Parameters retrieving method.
 CoopnSyntacticSection[] sections()
          Get the sections of this module.
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
clone, equals, hashCode, toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Method Detail

moduleName

public java.lang.String moduleName()
Get the name. Must be defined in the inherited classes.
Returns:
a String representation of the module name. Never null.

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).
Returns:
the module kind.

compilInfo

public CoopnCompilInfo compilInfo()
Return the compilation information associated to this module.

kind

public java.lang.String kind()
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".
Returns:
a string defining the module kind.

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.

hasParameters

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

parameters

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

comment

public java.lang.String comment()
Comment retrieving method. This method must be defined in the inherited classes for returning the comment associated to this symbol.
Returns:
a string defining the associated comment, or null iff no comment is associated to this symbol.

sections

public CoopnSyntacticSection[] sections()
Get the sections of this module.
Returns:
The sections defined by this module.