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 writes of keys upto 100 characters in length and are expected to throw an exception if the key is longer than 255 characters. Keys should be kept as short as possible. Reads and removes must support keys longer than 256 characters.

Instances are assumed to be not threadsafe and mutable.

Since:

2.0

Method Summary

Methods

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

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.

put

Object put(String key,
         Object value)

Puts a setting value.

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.

Throws:

IllegalArgumentException - if value is not null, String, List, Properties or Map, or if the key is null or longer than 255 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.