com.atlassian.applinks.api
Interface PropertySet

All Known Subinterfaces:
ApplicationLink, EntityLink

public interface PropertySet

Provides access to settings.

The following types are supported:

Instances are assumed to be not threadsafe and mutable.

Since:
3.0

Method Summary
 java.lang.Object getProperty(java.lang.String key)
          Gets a setting value.
 java.lang.Object putProperty(java.lang.String key, java.lang.Object value)
          Puts a setting value.
 java.lang.Object removeProperty(java.lang.String key)
          Removes a setting value
 

Method Detail

getProperty

java.lang.Object getProperty(java.lang.String key)
Gets a setting value.

Parameters:
key - The setting key. Cannot be null
Returns:
The setting value. May be null

putProperty

java.lang.Object putProperty(java.lang.String key,
                             java.lang.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:
java.lang.IllegalArgumentException - if value is not String, List, Properties or null.

removeProperty

java.lang.Object removeProperty(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.


Copyright © 2011 Atlassian. All Rights Reserved.