com.atlassian.configurable
Interface ObjectConfigurable

All Known Subinterfaces:
JiraService, JiraServiceContainer
All Known Implementing Classes:
AbstractMessageHandlingService, AbstractService, AuditLogCleaningService, CacheFlusher, ClusterMessageCleaningService, DebugService, ExportService, FileService, ImapService, IndexSnapshotService, JellyService, JiraServiceContainerImpl, MailFetcherService, MailQueueService, MockJiraServiceContainer, NodeStateCheckerService, PopService, ReferenceDebugService, ReplicatedIndexCleaningService, UnloadableJiraServiceContainer

@PublicSpi
public interface ObjectConfigurable

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

Author:
Owen Fellows

Method Summary
 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
 com.opensymphony.module.propertyset.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
 

Method Detail

getObjectConfiguration

ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException
Retrieves an object configuration object with properties that can be set

Returns:
ObjectConfiguration object
Throws:
ObjectConfigurationException

hasProperty

boolean hasProperty(String propertyKey)
                    throws ObjectConfigurationException
Checks if this object has a particular property

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

getProperty

String getProperty(String propertyKey)
                   throws ObjectConfigurationException
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

getTextProperty

String getTextProperty(String propertyKey)
                       throws ObjectConfigurationException
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

getLongProperty

Long getLongProperty(String propertyKey)
                     throws ObjectConfigurationException
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

getDefaultProperty

String getDefaultProperty(String propertyKey)
                          throws ObjectConfigurationException
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

getProperties

com.opensymphony.module.propertyset.PropertySet getProperties()
                                                              throws ObjectConfigurationException
Retrieve all the specified Properties for this object

Returns:
Set of properties for this object
Throws:
ObjectConfigurationException

getKey

String getKey()
Return the key of this object

Returns:
Key of object


Copyright © 2002-2015 Atlassian. All Rights Reserved.