ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaHeader

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
        |
        +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSection
              |
              +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaHeader
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticHeaderSection, CoopnSyntacticSection, java.io.Serializable

public class CoalaHeader
extends CoalaSection
implements CoopnSyntacticHeaderSection

Coala header.

See Also:
CoalaSection, Serialized Form

Constructor Summary
CoalaHeader(CoalaModuleName name)
          Simple constructor.
 
Method Summary
 java.lang.String basedUpon()
          Get the module upon which this section is based.
 int basedUponKind()
          Get the module kind (in the sense of the package manager) of the module upon which this section is based, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
 java.lang.Object clone()
          Cloning method.
 boolean equals(java.lang.Object obj)
          Equality method.
 CoopnSyntacticField[] fields()
          Get the fields of this section.
 boolean hasBasedUpon()
          Test if this section is based upon another module.
 int hashCode()
          Hashcode method.
 java.lang.String kind()
          Kind retrieving method.
 CoalaModuleName name()
           
 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.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

CoalaHeader

public CoalaHeader(CoalaModuleName name)
Simple constructor.
Method Detail

hasBasedUpon

public boolean hasBasedUpon()
Description copied from interface: CoopnSyntacticHeaderSection
Test if this section is based upon another module.
Specified by:
hasBasedUpon in interface CoopnSyntacticHeaderSection
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticHeaderSection
Returns:
true iff this section is based upon anither module.

basedUpon

public java.lang.String basedUpon()
Description copied from interface: CoopnSyntacticHeaderSection
Get the module upon which this section is based.
Specified by:
basedUpon in interface CoopnSyntacticHeaderSection
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticHeaderSection
Returns:
The name of the module upon which this section is based, or null.

basedUponKind

public int basedUponKind()
Get the module kind (in the sense of the package manager) of the module upon which this section is based, for instance COOPNSOURCE, COALASOURCE, PACKAGE, and so on).
Specified by:
basedUponKind in interface CoopnSyntacticHeaderSection
Returns:
the module kind of the module upon which this section is based, iff this section is based upon a module; a meaningless value else.

kind

public java.lang.String kind()
Description copied from interface: CoopnSyntacticSection
Kind retrieving method. This method must be defined in the inherited classes for returning a string allowing the user to know what kind of section this is.
Specified by:
kind in interface CoopnSyntacticSection
Overrides:
kind in class CoalaSection
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSection
Returns:
a string defining the section kind.

fields

public CoopnSyntacticField[] fields()
Description copied from interface: CoopnSyntacticSection
Get the fields of this section.
Specified by:
fields in interface CoopnSyntacticSection
Overrides:
fields in class CoalaSection
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSection
Returns:
The fields defined by this section.

name

public CoalaModuleName name()

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.

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.