ConForM.CoopnTools.CoKer.SpecMgr
Class SpecHeader

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.SpecMgr.SpecElement
        |
        +--ConForM.CoopnTools.CoKer.SpecMgr.SpecHeader
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticHeaderSection, CoopnSyntacticSection, java.io.Serializable

public final class SpecHeader
extends SpecElement
implements CoopnSyntacticHeaderSection

Specification file header.

See Also:
SpecElement, Serialized Form

Constructor Summary
SpecHeader()
          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.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 java.lang.Object unmodifiableCopy()
          Copy the element into an unmodifiable structure.
 
Methods inherited from class ConForM.CoopnTools.CoKer.SpecMgr.SpecElement
cloneSpecElement, toCompleteString, toCompleteString, toCompleteString, 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
 

Constructor Detail

SpecHeader

public SpecHeader()
Simple constructor.
Method Detail

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
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
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSection
Returns:
The fields defined by this section.

hasBasedUpon

public final boolean hasBasedUpon()
Test if this section is based upon another module.
Specified by:
hasBasedUpon in interface CoopnSyntacticHeaderSection
Returns:
true iff this section is based upon anither module.

basedUpon

public final java.lang.String basedUpon()
Get the module upon which this section is based.
Specified by:
basedUpon in interface 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.

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 SpecElement
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 SpecElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
the hash code.

toString

public java.lang.String toString(CoopnEnv env,
                                 int indent)
Description copied from interface: CoopnSyntacticElement
String conversion method. This routine converts an element into a string representing it. The string representation is intended to be readable from users. The string representation is not required to include the comments associated to the element, if any.
Specified by:
toString in interface CoopnSyntacticElement
Overrides:
toString in class SpecElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Parameters:
env - the environment deciding the form of the display. A null values indicates a default form.
indent - the identation factor. A zero value indicates no indentation at all.
Returns:
a String image of the element.

unmodifiableCopy

public java.lang.Object unmodifiableCopy()
Description copied from class: SpecElement
Copy the element into an unmodifiable structure.
Overrides:
unmodifiableCopy in class SpecElement
Following copied from class: ConForM.CoopnTools.CoKer.SpecMgr.SpecElement
Returns:
an unmodififable clone of the element.

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