jadex.bridge

Class ComponentIdentifier

java.lang.Object

jadex.bridge.ComponentIdentifier

All Implemented Interfaces:

IComponentIdentifier, java.io.Serializable, java.lang.Cloneable

public class ComponentIdentifier
extends java.lang.Object
implements IComponentIdentifier, java.lang.Cloneable, java.io.Serializable

A component identifier. Name is unique and has the form

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The component name.
protected java.lang.String	root Cache for platform name for getRoot() calls.

Fields inherited from interface jadex.bridge.IComponentIdentifier

EMPTY_COMPONENTIDENTIFIERS, LOCAL, RESULTCID

Constructor Summary

Constructors

Constructor and Description
ComponentIdentifier() Create a new component identifier.
ComponentIdentifier(IComponentIdentifier cid) Copy a component identifier.
ComponentIdentifier(java.lang.String name) Create a new component identifier with a global name and given addresses.
ComponentIdentifier(java.lang.String name, IComponentIdentifier parent) Create component identifier.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this component identifier.
boolean	equals(java.lang.Object obj) Test if two component identifiers are equal.
java.lang.String	getDotName() Get the name without @ replaced by dot.
java.lang.String	getLocalName() Get the local component name.
java.lang.String	getName() Get the component name.
IComponentIdentifier	getParent() Get the parent identifier.
java.lang.String	getPlatformName() Get the platform name.
java.lang.String	getPlatformPrefix() Get the platform name without the suffix for name uniqueness.
static java.lang.String	getPlatformPrefix(java.lang.String name) Get the stripped platform name.
IComponentIdentifier	getRoot() Get the root identifier.
int	hashCode() The hash code of the object.
void	setName(java.lang.String name) Set the component name.
java.lang.String	toString() Return a string representation.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

The component name.

root

protected java.lang.String root

Cache for platform name for getRoot() calls.

Constructor Detail

ComponentIdentifier

public ComponentIdentifier()

Create a new component identifier. Bean constructor

ComponentIdentifier

public ComponentIdentifier(java.lang.String name)

Create a new component identifier with a global name and given addresses.

Parameters:

name - A global name (e.g. "cms@lars").

ComponentIdentifier

public ComponentIdentifier(java.lang.String name,
                           IComponentIdentifier parent)

Create component identifier.

Parameters:

name - The local name.

parent - The parent.

addresses - The addresses.

ComponentIdentifier

public ComponentIdentifier(IComponentIdentifier cid)

Copy a component identifier.

Parameters:

cid - The id to copy from.

Method Detail

getName

public java.lang.String getName()

Get the component name.

Specified by:

getName in interface IComponentIdentifier

Returns:

The name of an component.

setName

public void setName(java.lang.String name)

Set the component name.

Parameters:

name - The component name.

getParent

public IComponentIdentifier getParent()

Get the parent identifier.

Specified by:

getParent in interface IComponentIdentifier

Returns:

The parent identifier (if any).

getRoot

public IComponentIdentifier getRoot()

Get the root identifier.

Specified by:

getRoot in interface IComponentIdentifier

Returns:

The root identifier.

clone

public java.lang.Object clone()

Clone this component identifier. Does a deep copy.

Overrides:

clone in class java.lang.Object

getLocalName

public java.lang.String getLocalName()

Description copied from interface: IComponentIdentifier

Get the local component name.

Specified by:

getLocalName in interface IComponentIdentifier

Returns:

the local name of a component

getPlatformName

public java.lang.String getPlatformName()

Get the platform name.

Specified by:

getPlatformName in interface IComponentIdentifier

Returns:

The platform name.

getDotName

public java.lang.String getDotName()

Get the name without @ replaced by dot.

Specified by:

getDotName in interface IComponentIdentifier

Returns:

The dot name.

getPlatformPrefix

public java.lang.String getPlatformPrefix()

Get the platform name without the suffix for name uniqueness.

Specified by:

getPlatformPrefix in interface IComponentIdentifier

Returns:

The platform name without suffix.

hashCode

public int hashCode()

The hash code of the object.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode.

equals

public boolean equals(java.lang.Object obj)

Test if two component identifiers are equal.

Overrides:

equals in class java.lang.Object

Returns:

True, if equal.

toString

public java.lang.String toString()

Return a string representation.

Overrides:

toString in class java.lang.Object

Returns:

The string representation.

getPlatformPrefix

public static java.lang.String getPlatformPrefix(java.lang.String name)

Get the stripped platform name.

Parameters:

name - The platform name.

Returns:

the stripped platform name.