ConForM.CoopnTools.CoKer.SpecMgr
Class SpecSourceSymbol

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.SpecMgr.SpecElement
        |
        +--ConForM.CoopnTools.CoKer.SpecMgr.SpecSymbol
              |
              +--ConForM.CoopnTools.CoKer.SpecMgr.SpecSourceSymbol
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticSymbol, CoopnSyntacticUseSymbol, java.io.Serializable

public final class SpecSourceSymbol
extends SpecSymbol
implements CoopnSyntacticUseSymbol

Spec source symbols. Define a CO-OPN source module belonging to the specification.

See Also:
SpecElement, Serialized Form

Fields inherited from class ConForM.CoopnTools.CoKer.SpecMgr.SpecSymbol
comment, symbolIdentifier, symbolModule, symbolName
 
Constructor Summary
SpecSourceSymbol(java.lang.String module, java.lang.String symbolModule)
          Simple constructor.
SpecSourceSymbol(java.lang.String module, java.lang.String symbolModule, java.lang.String comment)
          Simple constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Equality method.
 java.lang.String kind()
          Kind retrieving method.
 java.lang.String module()
          Return the module.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 int usedModuleKind()
          Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
 java.lang.String[] uses()
          Get the use modules.
 
Methods inherited from class ConForM.CoopnTools.CoKer.SpecMgr.SpecSymbol
clone, comment, hashCode, identifier, symbolModule, symbolModuleKind, symbolName, unmodifiableCopy
 
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.CoopnSyntacticSymbol
comment, identifier, symbolModule, symbolModuleKind, symbolName
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
clone, hashCode, toCompleteString, toCompleteString, toCompleteString, toString, toString
 

Constructor Detail

SpecSourceSymbol

public SpecSourceSymbol(java.lang.String module,
                        java.lang.String symbolModule,
                        java.lang.String comment)
Simple constructor.
Parameters:
module - the module name
symbolModule - the definitin module
comment - the associated comment

SpecSourceSymbol

public SpecSourceSymbol(java.lang.String module,
                        java.lang.String symbolModule)
Simple constructor.
Parameters:
module - the module name
symbolModule - the definitin module
Method Detail

module

public java.lang.String module()
Return the module.
Returns:
the module

kind

public final java.lang.String kind()
Description copied from interface: CoopnSyntacticSymbol
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.
Specified by:
kind in interface CoopnSyntacticSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSymbol
Returns:
a string defining the symbol kind.

usedModuleKind

public int usedModuleKind()
Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
Specified by:
usedModuleKind in interface CoopnSyntacticUseSymbol

uses

public java.lang.String[] uses()
Get the use modules. Must be defined in the inherited classes.
Specified by:
uses in interface CoopnSyntacticUseSymbol
Returns:
an array of String denoting the used modules.

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 SpecSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Parameters:
obj - the object to compare
Returns:
true iff this object and the parameter are equals.

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 SpecSymbol
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.