org.codehaus.cargo.generic.internal.util

Class RegistrationKey

java.lang.Object

org.codehaus.cargo.generic.internal.util.RegistrationKey

public class RegistrationKey
extends Object

A key used to register Cargo object implementation classes (configurations, deployables, deployers, etc) against containers.

Constructor Summary

Constructors

Constructor and Description
RegistrationKey(ContainerIdentity containerIdentity, String hint)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object registrationKey) Differentiate two keys.
ContainerIdentity	getContainerIdentity()
String	getHint()
int	hashCode() Allows quick verification to check is two keys are different.
String	toString(String implementationConceptName)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrationKey

public RegistrationKey(ContainerIdentity containerIdentity,
                       String hint)

Parameters:

containerIdentity - the container to which the Cargo object implementation class will be associated with.

hint - A general purpose string. This is used to differentiate different Cargo object implementation classes when they are registered against the same container. For example for configurations we're using "standalone", "existing" or "runtime".

Method Detail

getContainerIdentity

public ContainerIdentity getContainerIdentity()

Returns:

the container identity

See Also:

RegistrationKey(ContainerIdentity, String)

getHint

public String getHint()

Returns:

the hint associated with the registration of the Cargo object implementation classes

See Also:

RegistrationKey(ContainerIdentity, String)

equals

public boolean equals(Object registrationKey)

Differentiate two keys. Needed as we're using this class as an index in a Map.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Allows quick verification to check is two keys are different. Needed as we're using this class as an index in a Map.

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString(String implementationConceptName)

Parameters:

implementationConceptName - implementation concept name.

Returns:

string with container identity, concept name and hint.