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

SettingKey is composed by [context,scope,key], associates with a specified setting property value. Use SettingKey to specify context of setting property in action with database, cache or in dispatching setting event.

See Also:

Serialized Form

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

SettingKey(Context context, Scope scope, String key)
Create setting key with composite key [context,scope,key]

Method Summary

boolean	equals(Object obj)
String	getKey() get key value of setting-key
int	hashCode()
void	setKey(String key) set key value to setting-key

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)

Create setting key with composite key [context,scope,key]

Parameters:

context - context with which the specified value is to be associated

scope - scope with which the specified value is to be associated

key - key with which the specified value is to be associated

Method Detail

getKey

public String getKey()

get key value of setting-key

Returns:

value of key

setKey

public void setKey(String key)

set key value to setting-key

Parameters:

key -

equals

public boolean equals(Object obj)

Overrides:

equals in class SettingScope

hashCode

public int hashCode()

Overrides:

hashCode in class SettingScope