com.atlassian.jira.config.properties
Interface ApplicationProperties
- All Known Implementing Classes:
- ApplicationPropertiesImpl, MockApplicationProperties
@PublicApi
public interface ApplicationProperties
This can be used to lookup JIRA application properties. This uses a two stage strategy for finding property values.
First the database is checked to see if a value exists. If it doesnt exist, it falls back to the
file for a value.
Once a key is placed in the database (via an upgrade task or UI interaction) then it will always be loaded from
the database.
NOTE : Be very careful with boolean property values. Because of the way OSPropertySets work, its impossible to
distinguish between properties that have a false value and properties that have NO value. Therefore it is usually
better to have a "String" property set to the value "true" or "false" and then use Boolean.valueOf()
in it. This way it's possible to distinguish the absence of a property value from it being set to false.
getText
String getText(String name)
getDefaultBackedText
String getDefaultBackedText(String name)
setText
void setText(String name,
String value)
getString
String getString(String name)
getDefaultKeys
Collection<String> getDefaultKeys()
getDefaultBackedString
String getDefaultBackedString(String name)
getDefaultString
String getDefaultString(String name)
setString
void setString(String name,
String value)
getOption
boolean getOption(String key)
getKeys
Collection<String> getKeys()
setOption
void setOption(String key,
boolean value)
getEncoding
String getEncoding()
getMailEncoding
String getMailEncoding()
getContentType
String getContentType()
refresh
void refresh()
getDefaultLocale
Locale getDefaultLocale()
getStringsWithPrefix
Collection<String> getStringsWithPrefix(String prefix)
asMap
Map<String,Object> asMap()
- This will return all application and typed values. For example if the property is a boolean
then a Boolean object will be returned.
If an application property has a null value, then the key will still be in the
Map.keySet()
- Returns:
- a map of key to actual value object
Copyright © 2002-2012 Atlassian. All Rights Reserved.