com.atlassian.applinks.api

Interface PropertySet

All Known Subinterfaces:

ApplicationLink, EntityLink

public interface PropertySet

Provides access to settings.

The following types are supported:

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

Instances are assumed to be not threadsafe and mutable.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
Object	getProperty(String key) Gets a setting value.
Object	putProperty(String key, Object value) Puts a setting value.
Object	removeProperty(String key) Removes a setting value

Method Detail

getProperty

Object getProperty(String key)

Gets a setting value.

Parameters:

key - The setting key. Cannot be null

Returns:

The setting value. May be null

putProperty

Object putProperty(String key,
                   Object value)

Puts a setting value. Note that the namespace for this key is shared between all applinks consumers. If you don't want a different plugin to override a property you have set, ensure that you use a unique key. A good way to do this is to prefix the key with your plugin key, which is guaranteed to be globally unique.

Parameters:

key - Setting key. Cannot be null

value - Setting value. Must be one of String, List, Properties or null. a null value is equivalent to removeProperty(String)

Returns:

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

Throws:

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

removeProperty

Object removeProperty(String key)

Removes a setting value

Parameters:

key - The setting key

Returns:

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