ConForM.CoopnTools.CoKer
Interface CoopnSyntacticSymbol

All Superinterfaces:
java.lang.Cloneable, CoopnSyntacticElement, java.io.Serializable
All Known Subinterfaces:
CoopnSyntacticFunctionnalSymbol, CoopnSyntacticParamSymbol, CoopnSyntacticRelationnalSymbol, CoopnSyntacticUseSymbol
All Known Implementing Classes:
CoalaSymbol, ConstraintsSymbol, CoopnSymbol, PackageSymbol, SpecSymbol

public interface CoopnSyntacticSymbol
extends CoopnSyntacticElement

Coopn syntactic symbol. This interface defines simple symbols of the various abstract syntaxes used by CoopnTools.


Method Summary
 java.lang.String comment()
          Comment retrieving method.
 java.lang.String identifier()
          Get the identifier.
 java.lang.String kind()
          Kind retrieving method.
 java.lang.String symbolModule()
          Get the module.
 int symbolModuleKind()
          Get the module kind (in the sense of the package manager) of the module defining the symbol, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
 java.lang.String symbolName()
          Get the name.
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
clone, equals, hashCode, toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Method Detail

symbolName

public java.lang.String symbolName()
Get the name. Must be defined in the inherited classes.
Returns:
a String representation of the symbol name, or null iff the symbol has no name.

identifier

public java.lang.String identifier()
Get the identifier. Must be defined in the inherited classes.
Returns:
a String representation of the symbol identifier, which is never null.

symbolModule

public java.lang.String symbolModule()
Get the module. Must be defined in the inherited classes.
Returns:
a String representation of the name of the module defining the symbol, which is never null.

symbolModuleKind

public int symbolModuleKind()
Get the module kind (in the sense of the package manager) of the module defining the symbol, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
Returns:
the module kind.

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 symbol this is.
Returns:
a string defining the symbol kind.

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.