jadex.bridge

Class ComponentIdentifier

java.lang.Object

jadex.bridge.ComponentIdentifier

All Implemented Interfaces:

IComponentIdentifier, Serializable, Cloneable

public class ComponentIdentifier
extends Object
implements IComponentIdentifier, Cloneable, Serializable

An component identifier (AID), see FIPASC00023.

See Also:

Serialized Form

Field Summary

Fields inherited from interface jadex.bridge.IComponentIdentifier

EMPTY_COMPONENTIDENTIFIERS, LOCAL

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentIdentifier

public ComponentIdentifier()

Create a new component identifier. Bean constructor

ComponentIdentifier

public ComponentIdentifier(String name)

Create a new component identifier with a given global name.

Parameters:

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

ComponentIdentifier

public ComponentIdentifier(String name,
                   String[] addresses)

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

Parameters:

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

addresses - A list of transport addresses.

ComponentIdentifier

public ComponentIdentifier(String name,
                   IComponentIdentifier parent)

Create component identifier.

Parameters:

name - The local name.

parent - The parent.

addresses - The addresses.

ComponentIdentifier

public ComponentIdentifier(String name,
                   IComponentIdentifier parent,
                   String[] addresses)

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 String getName()

Get the component name.

Specified by:

getName in interface IComponentIdentifier

Returns:

The name of an component.

setName

public void setName(String name)

Set the component name.

Parameters:

name - The component name.

getAddresses

public String[] getAddresses()

Get the addresses of this ComponentIdentifier.

Specified by:

getAddresses in interface IComponentIdentifier

Returns:

addresses

setAddresses

public void setAddresses(String[] addresses)

Set the addresses of this ComponentIdentifier.

Parameters:

addresses - the value to be set

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 Object clone()

Clone this component identifier. Does a deep copy.

Overrides:

clone in class Object

getLocalName

public 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 String getPlatformName()

Get the platform name.

Specified by:

getPlatformName in interface IComponentIdentifier

Returns:

The platform name.

getPlatformPrefix

public 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 Object

Returns:

The hashcode.

equals

public boolean equals(Object obj)

Test if two component identifiers are equal.

Overrides:

equals in class Object

Returns:

True, if equal.

toString

public String toString()

Return a string representation.

Overrides:

toString in class Object

Returns:

The string representation.

getPlatformPrefix

public static String getPlatformPrefix(String name)

Get the stripped platform name.

Parameters:

name - The platform name.

Returns:

the stripped platform name.