Summary: Methods | [Expand All]
@PublicSpi public interface

ObjectConfigurable

com.atlassian.configurable.ObjectConfigurable
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

This interface should be implemented by any classes that are configured using an Object Configuration.

Summary

Public Methods
String getDefaultProperty(String propertyKey)
Returns the default property value for a key
String getKey()
Return the key of this object
Long getLongProperty(String propertyKey)
Returns a property of this object with the specified key as a long
ObjectConfiguration getObjectConfiguration()
Retrieves an object configuration object with properties that can be set
PropertySet getProperties()
Retrieve all the specified Properties for this object
String getProperty(String propertyKey)
Returns a property of this object with the specified key
String getTextProperty(String propertyKey)
Returns a property of this object with the specified key, the property is of type text
boolean hasProperty(String propertyKey)
Checks if this object has a particular property

Public Methods

public String getDefaultProperty (String propertyKey)

Returns the default property value for a key

Parameters
propertyKey String key used to retrieve the properties default value
Returns
  • Default property key
Throws
ObjectConfigurationException

public String getKey ()

Return the key of this object

Returns
  • Key of object

public Long getLongProperty (String propertyKey)

Returns a property of this object with the specified key as a long

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public ObjectConfiguration getObjectConfiguration ()

Retrieves an object configuration object with properties that can be set

Returns
  • ObjectConfiguration object
Throws
ObjectConfigurationException

public PropertySet getProperties ()

Retrieve all the specified Properties for this object

Returns
  • Set of properties for this object
Throws
ObjectConfigurationException

public String getProperty (String propertyKey)

Returns a property of this object with the specified key

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public String getTextProperty (String propertyKey)

Returns a property of this object with the specified key, the property is of type text

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public boolean hasProperty (String propertyKey)

Checks if this object has a particular property

Parameters
propertyKey to look for
Returns
  • true If there is a value
Throws
ObjectConfigurationException