org.exoplatform.commons.api.settings.data

Class SettingKey

java.lang.Object

org.exoplatform.commons.api.settings.data.SettingContext

org.exoplatform.commons.api.settings.data.SettingScope

org.exoplatform.commons.api.settings.data.SettingKey

All Implemented Interfaces:

Serializable

public class SettingKey
extends SettingScope

Associates setting properties with a specified key. SettingKey is composed by [context, scope, key], and is used to specify context of setting properties at the Key level when working with database, cache or dispatching the setting event.

See Also:

Serialized Form

Level API:

Experimental

Field Summary

Fields inherited from class org.exoplatform.commons.api.settings.data.SettingScope

scope, scopePath

Fields inherited from class org.exoplatform.commons.api.settings.data.SettingContext

context, ContextPath, repositoryName

Constructor Summary

Constructors

Constructor and Description
SettingKey(Context context, Scope scope, String key) Creates a SettingKey with a composite value [context, scope, key].

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares a specified object with the SettingKey for equality.
String	getKey() Gets a key value of the SettingKey object.
int	hashCode() Returns the hash code value for the SettingKey object.
void	setKey(String key) Sets a key value of the SettingKey object.

Methods inherited from class org.exoplatform.commons.api.settings.data.SettingScope

getScope, getScopePath

Methods inherited from class org.exoplatform.commons.api.settings.data.SettingContext

getContext, getContextPath, getCurrentRepositoryName, getRepositoryName

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingKey

public SettingKey(Context context,
          Scope scope,
          String key)

Creates a SettingKey with a composite value [context, scope, key].

Parameters:

context - The context value.

scope - The scope value.

key - The key value.

Level API:

Experimental

Method Detail

getKey

public String getKey()

Gets a key value of the SettingKey object.

Returns:

The key value.

Level API:

Experimental

setKey

public void setKey(String key)

Sets a key value of the SettingKey object.

Parameters:

key - The key value.

Level API:

Experimental

equals

public boolean equals(Object obj)

Compares a specified object with the SettingKey for equality.

Overrides:

equals in class SettingScope

hashCode

public int hashCode()

Returns the hash code value for the SettingKey object.

Overrides:

hashCode in class SettingScope