org.exoplatform.commons.scope

Class ScopedKey<S extends Serializable>

java.lang.Object

org.exoplatform.commons.scope.AbstractScopedKey

org.exoplatform.commons.scope.ScopedKey<S>

All Implemented Interfaces:

Serializable

public class ScopedKey<S extends Serializable>
extends AbstractScopedKey

A scoped key wrapping a key including the a scope. The scoped key implements the hashCode() and equals(Object) method based on the scope and the current value.

Version:

$Revision$

Author:

Julien Viet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScopedKey(S key)
ScopedKey(String scope, S key)

Method Summary

Methods

Modifier and Type	Method and Description
static <S extends Serializable> ScopedKey<S>	create(S key) Create a scoped key from a key, the scope value is obtained from the ScopeManager.getCurrentScope() method.
static <S extends Serializable> ScopedKey<S>	create(String scope, S key) Creates a new scoped key with an explicit scope value.
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.
S	getKey()
int	hashCode() Returns the scope value hashCode.
String	toString()

Methods inherited from class org.exoplatform.commons.scope.AbstractScopedKey

getScope

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopedKey

public ScopedKey(S key)
          throws NullPointerException

Throws:

NullPointerException

ScopedKey

public ScopedKey(String scope,
         S key)
          throws NullPointerException

Throws:

NullPointerException

Method Detail

create

public static <S extends Serializable> ScopedKey<S> create(S key)
                                                throws NullPointerException

Create a scoped key from a key, the scope value is obtained from the ScopeManager.getCurrentScope() method.

Type Parameters:

S - the key generic serializable type

Parameters:

key - the local key

Returns:

the scoped key

Throws:

NullPointerException - if the key argument is null

create

public static <S extends Serializable> ScopedKey<S> create(String scope,
                                           S key)
                                                throws NullPointerException

Creates a new scoped key with an explicit scope value.

Type Parameters:

S - the key generic serializable type

Parameters:

scope - the scope value

key - the key

Returns:

the scoped key

Throws:

NullPointerException - if any argument is null

getKey

public S getKey()

hashCode

public int hashCode()

Description copied from class: AbstractScopedKey

Returns the scope value hashCode.

Overrides:

hashCode in class AbstractScopedKey

Returns:

the hash code

equals

public boolean equals(Object obj)

Description copied from class: AbstractScopedKey

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 AbstractScopedKey

toString

public String toString()

Overrides:

toString in class Object