com.sonicsw.mf.common.runtime
Interface ICanonicalName

All Superinterfaces:

java.lang.Comparable

public interface ICanonicalName
extends java.lang.Comparable

The implmentation of this interface represents the canonical name form of a container ot component.

Method Summary

int	compareTo(java.lang.Object object) Compares this object with the specified object for order.
boolean	equals(java.lang.Object object) Tests if the given object is equal to this canonical name.
java.lang.String	getCanonicalName() Gets the full composite name of the instance.
java.lang.String	getComponentName() Get the component ID within the container (if the canonical name represents a component).
java.lang.String	getContainerName() Get the container name within the domain.
java.lang.String	getDomainName() Get the domain name to which the instance belongs.

Method Detail

compareTo

int compareTo(java.lang.Object object)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException - If the given object is not an instance of an ICanonicalName

equals

boolean equals(java.lang.Object object)

Tests if the given object is equal to this canonical name.

Overrides:

equals in class java.lang.Object

Returns:

Returns true if the canonical name of this object equals that of the given object. Returns false if the given object is not an instance of ICanonicalName or the stringified names match.

getCanonicalName

java.lang.String getCanonicalName()

Gets the full composite name of the instance. The canonical name will vary depending upon the instance implementation, for example:

• a containers cananocial name might be: "Sonic.Container"
• a components cananocial name might be: "Sonic.Container:ID=SonicMQ"

getComponentName

java.lang.String getComponentName()

Get the component ID within the container (if the canonical name represents a component).

getContainerName

java.lang.String getContainerName()

Get the container name within the domain.

getDomainName

java.lang.String getDomainName()

Get the domain name to which the instance belongs.