ConForM.CoopnTools.CoKer.CoalaMgr
Class CoalaCaaInterface

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
        |
        +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSection
              |
              +--ConForM.CoopnTools.CoKer.CoalaMgr.CoalaCaaInterface
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticSection, java.io.Serializable
Direct Known Subclasses:
CoalaCaaBody

public class CoalaCaaInterface
extends CoalaSection

Coala CAA interface.

See Also:
CoalaElement, Serialized Form

Constructor Summary
CoalaCaaInterface()
          Simple constructor.
 
Method Summary
 void addExceptions(CoalaExceptionField list)
           
 void addRoles(CoalaRoleField list)
           
 void addUses(CoalaUseField list)
           
 java.lang.Object clone()
          Cloning method.
protected  ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement createTextElement()
           
 boolean equals(java.lang.Object obj)
          Equality method.
 CoalaExceptionField exceptions()
           
 CoopnSyntacticField[] fields()
          Get the fields of this section.
 int hashCode()
          Hashcode method.
 java.lang.String kind()
          Kind retrieving method.
 CoalaRoleField roles()
           
 ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toCompleteText(CoopnSymbolTable table)
          Complete textual elements conversion method.
 ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toText()
          Textual elements conversion method.
 CoalaUseField uses()
           
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
cloneCoalaElement, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteText, toString, 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, toString
 

Constructor Detail

CoalaCaaInterface

public CoalaCaaInterface()
Simple constructor.
Method Detail

kind

public java.lang.String kind()
Description copied from class: CoalaSection
Kind retrieving method. This method must be defined in the inherited classes for returning a string allowing the user to know what kind of field this is.
Overrides:
kind in class CoalaSection
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSection
Returns:
a string defining the field kind.

fields

public CoopnSyntacticField[] fields()
Description copied from class: CoalaSection
Get the fields of this section.
Overrides:
fields in class CoalaSection
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaSection
Returns:
The fields defined by this section.

uses

public CoalaUseField uses()

roles

public CoalaRoleField roles()

exceptions

public CoalaExceptionField exceptions()

addUses

public void addUses(CoalaUseField list)

addRoles

public void addRoles(CoalaRoleField list)

addExceptions

public void addExceptions(CoalaExceptionField list)

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

hashCode

public int hashCode()
Description copied from interface: CoopnSyntacticElement
Hashcode method. Must be defined in the inherited classes.
Overrides:
hashCode in class CoalaElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
the hash code.

createTextElement

protected ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement createTextElement()

toText

public ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toText()
Description copied from class: CoalaElement
Textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a user-friendly textual element representing it. The string interpretation of this element is very intuitive by a user, but may be incorrect in the sense that it may be rejected by a checker.
Overrides:
toText in class CoalaElement
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
Returns:
a CoopnTextElement image.

toCompleteText

public ConForM.CoopnTools.CoKer.CoalaMgr.CoalaTextMgr.CoalaTextElement toCompleteText(CoopnSymbolTable table)
Description copied from class: CoalaElement
Complete textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a correct textual element representing it. The string interpretation of this element will be accepted by a checker, but may be difficult to read by users, due to the additionnal information, like parenthesis and so on.
Overrides:
toCompleteText in class CoalaElement
Following copied from class: ConForM.CoopnTools.CoKer.CoalaMgr.CoalaElement
Parameters:
table - the symbol table used to generate symbol references
Returns:
a CoopnTextElement image.

clone

public java.lang.Object clone()
Description copied from interface: CoopnSyntacticElement
Cloning method. Must be defined in the inherited classes.
Overrides:
clone in class CoalaElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
a clone object.