ConForM.CoopnTools.CoKer.SpecMgr
Class SpecFunctionnalVariableSymbol

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

public class SpecFunctionnalVariableSymbol
extends SpecVariableSymbol

Spec functional variable 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
SpecFunctionnalVariableSymbol(java.lang.String variable, java.lang.String symbolModule, java.lang.String paramType, java.lang.String returnType)
          Simple constructor.
SpecFunctionnalVariableSymbol(java.lang.String variable, java.lang.String symbolModule, java.lang.String paramType, java.lang.String returnType, java.lang.String comment)
          Simple constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Equality method.
 java.lang.String kind()
          Kind retrieving method.
 int paramNumber()
          Get the number of parameters.
 java.lang.String paramType()
          Return the param type.
 java.lang.String returnType()
          Return the return type.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 
Methods inherited from class ConForM.CoopnTools.CoKer.SpecMgr.SpecVariableSymbol
arity, name
 
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

SpecFunctionnalVariableSymbol

public SpecFunctionnalVariableSymbol(java.lang.String variable,
                                     java.lang.String symbolModule,
                                     java.lang.String paramType,
                                     java.lang.String returnType,
                                     java.lang.String comment)
Simple constructor.
Parameters:
variable - the variable name
symbolModule - the definitin module
paramType - the parameter type
returnType - the return type
comment - the associated comment

SpecFunctionnalVariableSymbol

public SpecFunctionnalVariableSymbol(java.lang.String variable,
                                     java.lang.String symbolModule,
                                     java.lang.String paramType,
                                     java.lang.String returnType)
Simple constructor.
Parameters:
variable - the variable name
symbolModule - the definition module
paramType - the parameter type
returnType - the return type
Method Detail

paramType

public java.lang.String paramType()
Return the param type.
Returns:
the param type

returnType

public java.lang.String returnType()
Return the return type.
Returns:
the return type

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

paramNumber

public int paramNumber()
Get the number of parameters. Must be defined in the inherited classes.
Returns:
an integer, the actual number of parameter.

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