ConForM.CoopnTools.CoKer.PackageMgr
Class PackageUseSymbol

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

public final class PackageUseSymbol
extends PackageSymbol
implements CoopnSyntacticUseSymbol

Package use.

See Also:
PackageElement, Serialized Form

Fields inherited from class ConForM.CoopnTools.CoKer.PackageMgr.PackageSymbol
comment, symbolIdentifier, symbolModule, symbolName
 
Constructor Summary
PackageUseSymbol(java.lang.String symbolName, java.lang.String symbolModule, java.util.List moduleList)
          Simple constructor.
PackageUseSymbol(java.lang.String symbolName, java.lang.String symbolModule, java.util.List moduleList, java.lang.String comment)
          Simple constructor.
PackageUseSymbol(java.lang.String symbolName, java.lang.String symbolIdentifier, java.lang.String symbolModule, java.util.List moduleList)
          Simple constructor.
PackageUseSymbol(java.lang.String symbolName, java.lang.String symbolIdentifier, java.lang.String symbolModule, java.util.List moduleList, java.lang.String comment)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning method.
 boolean equals(java.lang.Object obj)
          Equality method.
 java.lang.String kind()
          Kind retrieving method.
 java.util.List modules()
           
 java.lang.String toString(CoopnEnv env, int indent)
          String conversion method.
 java.lang.Object unmodifiableCopy()
          Copy the element into an unmodififable structure.
 int usedModuleKind()
          Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
 java.lang.String[] uses()
          Get the use modules.
 
Methods inherited from class ConForM.CoopnTools.CoKer.PackageMgr.PackageSymbol
comment, hashCode, identifier, symbolModule, symbolModuleKind, symbolName
 
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.CoopnSyntacticSymbol
comment, identifier, symbolModule, symbolModuleKind, symbolName
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
hashCode, toCompleteString, toCompleteString, toCompleteString, toString, toString
 

Constructor Detail

PackageUseSymbol

public PackageUseSymbol(java.lang.String symbolName,
                        java.lang.String symbolIdentifier,
                        java.lang.String symbolModule,
                        java.util.List moduleList)
                 throws java.lang.IllegalArgumentException
Simple constructor.

PackageUseSymbol

public PackageUseSymbol(java.lang.String symbolName,
                        java.lang.String symbolModule,
                        java.util.List moduleList)
                 throws java.lang.IllegalArgumentException
Simple constructor.

PackageUseSymbol

public PackageUseSymbol(java.lang.String symbolName,
                        java.lang.String symbolIdentifier,
                        java.lang.String symbolModule,
                        java.util.List moduleList,
                        java.lang.String comment)
                 throws java.lang.IllegalArgumentException
Simple constructor.

PackageUseSymbol

public PackageUseSymbol(java.lang.String symbolName,
                        java.lang.String symbolModule,
                        java.util.List moduleList,
                        java.lang.String comment)
                 throws java.lang.IllegalArgumentException
Simple constructor.
Method Detail

modules

public final java.util.List modules()

usedModuleKind

public int usedModuleKind()
Get the kind of the used modules, in the sense of the package manager (for instance, COOPNSOURCE, COALA, PACKAGE and so on).
Specified by:
usedModuleKind in interface CoopnSyntacticUseSymbol

uses

public final java.lang.String[] uses()
Description copied from interface: CoopnSyntacticUseSymbol
Get the use modules. Must be defined in the inherited classes.
Specified by:
uses in interface CoopnSyntacticUseSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticUseSymbol
Returns:
an array of String denoting the used modules.

kind

public final 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.
Specified by:
kind in interface CoopnSyntacticSymbol
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticSymbol
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.
Specified by:
equals in interface CoopnSyntacticElement
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.
Specified by:
toString in interface CoopnSyntacticElement
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.

unmodifiableCopy

public java.lang.Object unmodifiableCopy()
Copy the element into an unmodififable structure.
Overrides:
unmodifiableCopy in class PackageSymbol
Returns:
an unmodififable clone of the element.

clone

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