com.atlassian.sal.api.pluginsettings
Interface PluginSettings

All Known Implementing Classes:

AbstractStringPluginSettings, MockPluginSettings, PrefixedPluginSettingsDelegate

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.

Implementations are only required to support keys up to 100 characters long. Some may support up to 255 characters, but keys should be kept as short as possible.

Instances are assumed to be not threadsafe and mutable.

Since:

2.0

Method Summary

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

Method Detail

get

Object get(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

Throws:

IllegalArgumentException - if the key is null or longer than 100 characters

put

Object put(String key,
           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:

IllegalArgumentException - if value is not String, List, Properties, Map, or null, or if the key is null or longer than 100 characters

remove

Object remove(String key)

Removes a setting value

Parameters:

key - The setting key

Returns:

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

Throws:

IllegalArgumentException - if the key is null or longer than 100 characters