ConForM.CoopnTools.CoKer.SpecMgr
Class SpecConstraintSymbol

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

public class SpecConstraintSymbol
extends SpecSymbol

Spec constraints symbols. Define a variable belonging to the specification.

See Also:
SpecElement, Serialized Form

Fields inherited from class ConForM.CoopnTools.CoKer.SpecMgr.SpecSymbol
comment, symbolIdentifier, symbolModule, symbolName
 
Constructor Summary
SpecConstraintSymbol(java.lang.String constraint, java.lang.String symbolModule)
          Simple constructor.
SpecConstraintSymbol(java.lang.String constraint, java.lang.String symbolModule, java.lang.String comment)
          Simple constructor.
 
Method Summary
 int arity()
          Symbol arity.
 boolean equals(java.lang.Object obj)
          Equality method.
 java.lang.String kind()
          Kind retrieving method.
 java.lang.String name()
          Get the variable name.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 
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.CoopnSyntacticElement
toCompleteString, toCompleteString, toCompleteString, toString, toString
 

Constructor Detail

SpecConstraintSymbol

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

SpecConstraintSymbol

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

name

public java.lang.String name()
Get the variable name.

kind

public 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.
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSymbol
Returns:
a string defining the symbol kind.

arity

public int arity()
Symbol arity.
Returns:
the arity, i.e. the number of "underline" in the variable name

equals

public boolean equals(java.lang.Object obj)
Description copied from interface: CoopnSyntacticElement
Equality method. Must be defined in the inherited classes.
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.
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.