ConForM.CoopnTools.CoKer.PackageMgr
Class PackageEntrySymbol

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.PackageMgr.PackageElement
        |
        +--ConForM.CoopnTools.CoKer.PackageMgr.PackageSymbol
              |
              +--ConForM.CoopnTools.CoKer.PackageMgr.PackageEntrySymbol
All Implemented Interfaces:
java.lang.Cloneable, CoopnSyntacticElement, CoopnSyntacticSymbol, java.io.Serializable

public final class PackageEntrySymbol
extends PackageSymbol

Package file module entries. Typically used for storing source fields, spec fields, and so on.

See Also:
PackageElement, Serialized Form

Fields inherited from class ConForM.CoopnTools.CoKer.PackageMgr.PackageSymbol
comment, symbolIdentifier, symbolModule, symbolName
 
Constructor Summary
PackageEntrySymbol(int moduleKind, java.lang.String module, java.lang.String file, java.lang.String symbolModule)
          Simple constructor.
PackageEntrySymbol(int moduleKind, java.lang.String module, java.lang.String file, java.lang.String symbolModule, java.lang.String comment)
          Simple constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Equality method.
 java.lang.String file()
          Return the file.
 java.lang.String kind()
          Kind retrieving method.
 java.lang.String module()
          Return the module.
 int moduleKind()
          Return the module kind.
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 
Methods inherited from class ConForM.CoopnTools.CoKer.PackageMgr.PackageSymbol
clone, comment, hashCode, identifier, symbolModule, symbolModuleKind, symbolName, unmodifiableCopy
 
Methods inherited from class ConForM.CoopnTools.CoKer.PackageMgr.PackageElement
clonePackageElement, 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

PackageEntrySymbol

public PackageEntrySymbol(int moduleKind,
                          java.lang.String module,
                          java.lang.String file,
                          java.lang.String symbolModule,
                          java.lang.String comment)
Simple constructor.
Parameters:
moduleKind - the kind of the module
module - the module name
file - the file name
symbolModule - the definitin module
comment - the associated comment

PackageEntrySymbol

public PackageEntrySymbol(int moduleKind,
                          java.lang.String module,
                          java.lang.String file,
                          java.lang.String symbolModule)
Simple constructor.
Parameters:
moduleKind - the kind of the module
module - the module name
file - the file name
symbolModule - the definitin module
Method Detail

module

public java.lang.String module()
Return the module.
Returns:
the module

moduleKind

public int moduleKind()
Return the module kind.
Returns:
the module kind

file

public java.lang.String file()
Return the file.
Returns:
the file

kind

public java.lang.String kind()
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.
Returns:
a string defining the symbol kind.

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