Package 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

eXo 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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

Methods inherited from class java.lang.Object

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

Constructor Details

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.

eXo level API

Experimental

Method Details

getKey

public String getKey()

Gets a key value of the SettingKey object.

Returns:

The key value.

eXo level API

Experimental

setKey

public void setKey(String key)

Sets a key value of the SettingKey object.

Parameters:

key - The key value.

eXo 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