org.exoplatform.commons.scope

Class AbstractScopedKey

java.lang.Object

org.exoplatform.commons.scope.AbstractScopedKey

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ScopedKey

public abstract class AbstractScopedKey
extends Object
implements Serializable

The abstract scoped key should be subclasses to create scoped key.

Version:

$Revision$

Author:

Julien Viet

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScopedKey()
protected	AbstractScopedKey(String scope)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns true when: the obj argument has the same reference than this object or the obj has class equality (getClass().equals(obj.getClass())) and scope equality Subclasses should override this method and call the super method to ensure that the objects are of the same class and have the same scope.
String	getScope()
int	hashCode() Returns the scope value hashCode.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScopedKey

protected AbstractScopedKey()

AbstractScopedKey

protected AbstractScopedKey(String scope)
                     throws NullPointerException

Throws:

NullPointerException

Method Detail

getScope

public final String getScope()

hashCode

public int hashCode()

Returns the scope value hashCode.

Overrides:

hashCode in class Object

Returns:

the hash code

equals

public boolean equals(Object obj)

Returns true when:

• the obj argument has the same reference than this object
• or the obj has class equality (getClass().equals(obj.getClass())) and scope equality

Subclasses should override this method and call the super method to ensure that the objects are of the same class and have the same scope. When this method returns true, the obj argument can be safely casted to the same sub class for performing more state equality checks.

Overrides:

equals in class Object