Package jadex.bridge
Interface IComponentIdentifier
-
- All Known Implementing Classes:
ComponentIdentifier
public interface IComponentIdentifier
Interface for component identifiers.
-
-
Field Summary
Fields Modifier and Type Field Description static IComponentIdentifier[]
EMPTY_COMPONENTIDENTIFIERS
Return value for empty arrays.static java.lang.ThreadLocal<IComponentIdentifier>
LOCAL
The currently executing component (if any).static java.lang.String
RESULTCID
The constant to fetch the component id out of the results of a component.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDotName()
Get the dot name.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.IComponentIdentifier
getRoot()
Get the root identifier.boolean
hasSameRoot(IComponentIdentifier cid)
Test if this identifier has the same root as the cid.
-
-
-
Field Detail
-
RESULTCID
static final java.lang.String RESULTCID
The constant to fetch the component id out of the results of a component.- See Also:
- Constant Field Values
-
LOCAL
static final java.lang.ThreadLocal<IComponentIdentifier> LOCAL
The currently executing component (if any).
-
EMPTY_COMPONENTIDENTIFIERS
static final IComponentIdentifier[] EMPTY_COMPONENTIDENTIFIERS
Return value for empty arrays.
-
-
Method Detail
-
getName
java.lang.String getName()
Get the component name.- Returns:
- The name of an component.
-
getLocalName
java.lang.String getLocalName()
Get the local component name.- Returns:
- The local name of an component.
-
getPlatformName
java.lang.String getPlatformName()
Get the platform name.- Returns:
- The platform name.
-
getPlatformPrefix
java.lang.String getPlatformPrefix()
Get the platform name without the suffix for name uniqueness.- Returns:
- The platform name without suffix.
-
getParent
IComponentIdentifier getParent()
Get the parent identifier.- Returns:
- The parent identifier (if any).
-
getRoot
IComponentIdentifier getRoot()
Get the root identifier.- Returns:
- The root identifier.
-
getDotName
java.lang.String getDotName()
Get the dot name.- Returns:
- The dot name.
-
hasSameRoot
boolean hasSameRoot(IComponentIdentifier cid)
Test if this identifier has the same root as the cid.- Parameters:
cid
- The component id.- Returns:
- True, if the root is equal.
-
-