com.atlassian.sal.core.pluginsettings

Class PrefixedPluginSettingsDelegate

java.lang.Object

com.atlassian.sal.core.pluginsettings.PrefixedPluginSettingsDelegate

All Implemented Interfaces:

PluginSettings

public class PrefixedPluginSettingsDelegate
extends Object
implements PluginSettings

PluginSettings implementation that delegates to another PluginSettings, adding a prefix to every key passed in

Constructor Summary

Constructors

Constructor and Description
PrefixedPluginSettingsDelegate(String prefix, PluginSettings target)

Method Summary

Modifier and Type	Method and Description
Object	get(String key) Gets a setting value.
Object	put(String key, Object value) Puts a setting value.
Object	remove(String key) Removes a setting value

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixedPluginSettingsDelegate

public PrefixedPluginSettingsDelegate(String prefix,
                                      PluginSettings target)

Method Detail

get

public Object get(String key)

Description copied from interface: PluginSettings

Gets a setting value. The setting returned should be specific to this context settings object and not cascade the value to a global context.

Specified by:

get in interface PluginSettings

Parameters:

key - The setting key. Cannot be null

Returns:

The setting value. May be null

put

public Object put(String key,
                  Object value)

Description copied from interface: PluginSettings

Puts a setting value.

Specified by:

put in interface PluginSettings

Parameters:

key - Setting key. Cannot be null, keys longer than 100 characters are not supported.

value - Setting value. Must be one of String, List, Properties, Map, or null. null will remove the item from the settings. If the value is a String it should not be longer than 99000 characters long. Values of a type other than String will be serialized as a String which cannot be longer than 99000 characters long.

Returns:

The setting value that was over ridden. Null if none existed.

remove

public Object remove(String key)

Description copied from interface: PluginSettings

Removes a setting value

Specified by:

remove in interface PluginSettings

Parameters:

key - The setting key

Returns:

The setting value that was removed. Null if nothing was removed.