ConForM.CoopnTools.CoKer
Interface CoopnSyntacticElement

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Subinterfaces:
CoopnSyntacticField, CoopnSyntacticFunctionnalSymbol, CoopnSyntacticHeaderSection, CoopnSyntacticModule, CoopnSyntacticParamSymbol, CoopnSyntacticPrivateSection, CoopnSyntacticRelationnalSymbol, CoopnSyntacticSection, CoopnSyntacticSymbol, CoopnSyntacticUseField, CoopnSyntacticUseSymbol
All Known Implementing Classes:
CoalaElement, ConstraintsElement, CoopnElement, PackageElement, ScenarioElement, SpecElement, CoopnSubstitution

public interface CoopnSyntacticElement
extends java.io.Serializable, java.lang.Cloneable

Coopn syntactic elements. This abstract class essentially defines basic synatctic elements of the various abstract syntaxes used by CoopnTools.


Method Summary
 java.lang.Object clone()
          Cloning method.
 boolean equals(java.lang.Object obj)
          Equality method.
 int hashCode()
          Hashcode method.
 java.lang.String toCompleteString()
          String conversion method.
 java.lang.String toCompleteString(CoopnEnv env)
          String conversion method.
 java.lang.String toCompleteString(CoopnEnv env, int indent)
          String conversion method.
 java.lang.String toString()
          String conversion method.
 java.lang.String toString(CoopnEnv env)
          String conversion method.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 

Method Detail

equals

public boolean equals(java.lang.Object obj)
Equality method. Must be defined in the inherited classes.
Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare
Returns:
true iff this object and the parameter are equals.

hashCode

public int hashCode()
Hashcode method. Must be defined in the inherited classes.
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code.

toString

public java.lang.String toString(CoopnEnv env,
                                 int indent)
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.
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.

toString

public java.lang.String toString(CoopnEnv env)
String conversion method. Use an identation of 0. 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.
Parameters:
env - the environment deciding the form of the display
Returns:
a String image of the element.

toString

public java.lang.String toString()
String conversion method. Use no environment and an identation of 0. 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 java.lang.Object
Returns:
a String image of the element.

toCompleteString

public java.lang.String toCompleteString(CoopnEnv env,
                                         int indent)
String conversion method. This routine converts an element into a string representing it. The string representation is intended to be as complete as possible, even if the resulting string is not more readable. The string representation is not required to include the comments associated to the element, if any.
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.

toCompleteString

public java.lang.String toCompleteString(CoopnEnv env)
String conversion method. Use an identation of 0. This routine converts an element into a string representing it. The string representation is intended to be as complete as possible, even if the resulting string is not more readable. The string representation is not required to include the comments associated to the element, if any.
Parameters:
env - the environment deciding the form of the display
Returns:
a String image of the element.

toCompleteString

public java.lang.String toCompleteString()
String conversion method. Use no environment and an identation of 0. This routine converts an element into a string representing it. The string representation is intended to be as complete as possible, even if the resulting string is not more readable. The string representation is not required to include the comments associated to the element, if any.
Returns:
a String image of the element.

clone

public java.lang.Object clone()
Cloning method. Must be defined in the inherited classes.
Overrides:
clone in class java.lang.Object
Returns:
a clone object.