ConForM.CoopnTools.CoKer.SpecMgr
Class SpecElement

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.SpecMgr.SpecElement
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, java.io.Serializable
Direct Known Subclasses:
SpecBehaviourSection, SpecField, SpecHeader, SpecModule, SpecModuleSection, SpecSymbol, SpecVariableSection

public abstract class SpecElement
extends java.lang.Object
implements CoopnSyntacticElement

Specification file elements.

See Also:
Serialized Form

Constructor Summary
SpecElement()
           
 
Method Summary
abstract  java.lang.Object clone()
          Cloning method.
protected  SpecElement cloneSpecElement()
          Internal cloning method.
abstract  boolean equals(java.lang.Object obj)
          Equality method.
abstract  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.
abstract  java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
abstract  java.lang.Object unmodifiableCopy()
          Copy the element into an unmodifiable structure.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpecElement

public SpecElement()
Method Detail

equals

public abstract boolean equals(java.lang.Object obj)
Equality method. Must be defined in the inherited classes.
Specified by:
equals in interface CoopnSyntacticElement
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 abstract int hashCode()
Hashcode method. Must be defined in the inherited classes.
Specified by:
hashCode in interface CoopnSyntacticElement
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code.

toString

public abstract java.lang.String toString(CoopnEnv env,
                                          int indent)
String conversion method. Must be defined in the inherited classes.
Specified by:
toString in interface CoopnSyntacticElement
Parameters:
env - the environment deciding the form of the display
indent - the identation factor
Returns:
a String image of the element.

toString

public java.lang.String toString(CoopnEnv env)
String conversion method. Use an identation of 0.
Specified by:
toString in interface CoopnSyntacticElement
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.
Specified by:
toString in interface CoopnSyntacticElement
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.
Specified by:
toCompleteString in interface 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.

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.
Specified by:
toCompleteString in interface CoopnSyntacticElement
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.
Specified by:
toCompleteString in interface CoopnSyntacticElement
Returns:
a String image of the element.

unmodifiableCopy

public abstract java.lang.Object unmodifiableCopy()
Copy the element into an unmodifiable structure.
Returns:
an unmodififable clone of the element.

cloneSpecElement

protected SpecElement cloneSpecElement()
Internal cloning method. Should be used by the inherited classed for implementing their own "clone" method.
Returns:
a clone element.

clone

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