com.atlassian.sal.api.pluginsettings
Interface PluginSettings

public interface PluginSettings

Provides access to settings globally or per project/space/repository/build-plan

The following types are supported:

• java.lang.String
• java.util.List
• java.util.Properties
• java.util.Map

List and Map types must contain only String.

Instances are assumed to be not threadsafe and mutable.

Since:

2.0

Method Summary

java.lang.Object	get(java.lang.String key) Gets a setting value.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Puts a setting value.
java.lang.Object	remove(java.lang.String key) Removes a setting value

Method Detail

get

java.lang.Object get(java.lang.String key)

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

Parameters:

key - The setting key. Cannot be null

Returns:

The setting value. May be null

put

java.lang.Object put(java.lang.String key,
                     java.lang.Object value)

Puts a setting value.

Parameters:

key - Setting key. Cannot be null

value - Setting value. Must be one of String, List, Properties, Map, or null. null will remove the item from the settings.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is not String, List, Properties, Map, or null.

remove

java.lang.Object remove(java.lang.String key)

Removes a setting value

Parameters:

key - The setting key

Returns:

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