org.xtce.toolkit

Class XTCEAlias

java.lang.Object

org.xtce.toolkit.XTCEAlias

public class XTCEAlias
extends Object

This class is a container for capturing the Alias information on an element in the XTCE data model, which is represented as an XTCENamedObject in the toolkit.

Author:

David Overeem

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object rhs) Equality Operator Function to compare one XTCEAlias object to another XTCEAlias object.
String	getAliasName() Retrieve the alias name
String	getFullAliasName() Retrieve the alias name and namespace name in the form of NS::ALIAS
String	getNameSpace() Retrieve the alias namespace
int	hashCode() Hash Code Operator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAliasName

public String getAliasName()

Retrieve the alias name

Returns:

String containing the alias name.

getNameSpace

public String getNameSpace()

Retrieve the alias namespace

Returns:

String containing the namespace name for this alias.

getFullAliasName

public String getFullAliasName()

Retrieve the alias name and namespace name in the form of NS::ALIAS

Returns:

String containing the alias name and namespace name.

equals

public boolean equals(Object rhs)

Equality Operator Function to compare one XTCEAlias object to another XTCEAlias object. Equality is defined as both the alias string and the namespace name being the same.

Overrides:

equals in class Object

Parameters:

rhs - XTCEAlias object to compare to.

Returns:

boolean indicating if the two XTCEAlias objects are effectively the same information.

hashCode

public int hashCode()

Hash Code Operator

Overrides:

hashCode in class Object

Returns:

int hash code based on the combination of the namespace and the alias names.