gov.llnl.babel.symbols

Class SymbolID

Implemented Interfaces:
Comparable
Known Direct Subclasses:
Symbol

public class SymbolID
extends ASTNode
implements Comparable

The SymbolID class represents the name of a symbol, which consists of a fully qualified name (e.g., "sidl.Object") and a version number. The equals and hashCode members have been defined such that two symbol ids are considered equal if they have the same version and string.

Field Summary

static String
SCOPE

Fields inherited from class gov.llnl.babel.symbols.ASTNode

d_frozen

Constructor Summary

SymbolID(String fully_qualified_name, Version version)
The constructor for the SymbolID class takes a fully qualified symbol name and a symbol version.
SymbolID(String fully_qualified_name, Version version, boolean fromxml)
The constructor for the SymbolID class takes a fully qualified symbol name and a symbol version.
SymbolID(SymbolID id)

Method Summary

int
compareTo(Object o)
Compare this SymbolID with another one.
boolean
equals(Object obj)
Two symbol identifiers are identical only if they have the same symbol identifiers and the same version.
boolean
fromXML()
String
getFullName()
Return the fully qualified name of the symbol.
String
getShortName()
Return the short, relative name of the symbol.
static String
getShortName(String fqn)
Return the short, relative name of the fully qualified name.
String
getSymbolName()
Return the symbol name of the form "NAME-vVERSION".
Version
getVersion()
Return the version of the symbol.
int
hashCode()
Return the hash code of the symbol name as the hash value for a symbol identifier to facilitiate searching in hash tables.
void
setFromXML(boolean fromxml)

Methods inherited from class gov.llnl.babel.symbols.ASTNode

checkFrozen, clone, freeze, protectCollection, protectList, protectMap, protectSet

Field Details

SCOPE

public static final String SCOPE

Constructor Details

SymbolID

public SymbolID(String fully_qualified_name,
                Version version)
The constructor for the SymbolID class takes a fully qualified symbol name and a symbol version.

SymbolID

public SymbolID(String fully_qualified_name,
                Version version,
                boolean fromxml)
The constructor for the SymbolID class takes a fully qualified symbol name and a symbol version. Flag fromxml indicates whether symbol originates from xml repository.

SymbolID

public SymbolID(SymbolID id)

Method Details

compareTo

public int compareTo(Object o)
Compare this SymbolID with another one.

equals

public boolean equals(Object obj)
Two symbol identifiers are identical only if they have the same symbol identifiers and the same version.

fromXML

public boolean fromXML()

getFullName

public String getFullName()
Return the fully qualified name of the symbol.

getShortName

public String getShortName()
Return the short, relative name of the symbol.

getShortName

public static String getShortName(String fqn)
Return the short, relative name of the fully qualified name.

getSymbolName

public String getSymbolName()
Return the symbol name of the form "NAME-vVERSION".

getVersion

public Version getVersion()
Return the version of the symbol.

hashCode

public int hashCode()
Return the hash code of the symbol name as the hash value for a symbol identifier to facilitiate searching in hash tables.

setFromXML

public void setFromXML(boolean fromxml)