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

java.lang.Object
  extended by org.codehaus.cargo.generic.internal.util.RegistrationKey

public class RegistrationKey
extends java.lang.Object

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

Version:
$Id: RegistrationKey.java 1705 2008-09-02 13:14:55Z adriana $

Constructor Summary
RegistrationKey(ContainerIdentity containerIdentity, java.lang.String hint)
           
 
Method Summary
 boolean equals(java.lang.Object registrationKey)
          Differentiate two keys.
 ContainerIdentity getContainerIdentity()
           
 java.lang.String getHint()
           
 int hashCode()
          Allows quick verification to check is two keys are different.
 java.lang.String toString(java.lang.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,
                       java.lang.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 java.lang.String getHint()
Returns:
the hint associated with the registration of the Cargo object implementation classes
See Also:
RegistrationKey(ContainerIdentity, String)

equals

public boolean equals(java.lang.Object registrationKey)
Differentiate two keys. Needed as we're using this class as an index in a Map.

Overrides:
equals in class java.lang.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 java.lang.Object
See Also:
Object.hashCode()

toString

public java.lang.String toString(java.lang.String implementationConceptName)

See Also:
Object.toString()


Copyright © 2004-2011 Codehaus. All Rights Reserved.