ApplicationPropertiesImpl (Atlassian JIRA

java.lang.Object
- com.atlassian.jira.config.properties.ApplicationPropertiesImpl

All Implemented Interfaces:

ApplicationProperties
```
public class ApplicationPropertiesImpl
extends Object
implements ApplicationProperties
```
A class to manage the interface with a single property set, used for application properties

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ENCODING

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ENCODING`

Constructor Summary

Constructors
Constructor and Description

ApplicationPropertiesImpl(ApplicationPropertiesStore applicationPropertiesStore)

Constructors
Constructor and Description
`ApplicationPropertiesImpl(ApplicationPropertiesStore applicationPropertiesStore)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`asMap()` This will return all application and typed values.
`String`	`getContentType()`
`String`	`getDefaultBackedString(String name)` Get the property from the application properties, but if not found, try to get from the default properties file.
`String`	`getDefaultBackedText(String name)` Get the property from the application properties, but if not found, try to get from the default properties file.
`Collection<String>`	`getDefaultKeys()` Get all the keys from the default properties
`Locale`	`getDefaultLocale()` Returns the default `Locale` set up on the JIRA instance.
`String`	`getDefaultString(String name)` Get the default property (if the property is not set)
`String`	`getEncoding()` Returns the encoding to be used by JIRA from the application properties.
`Collection<String>`	`getKeys()`
`String`	`getMailEncoding()` Convenience method to get the email encoding
`boolean`	`getOption(String key)` Get the option from the application properties, but if not found, try to get from the default properties file.
`String`	`getString(String name)` Returns the value of the given key.
`Collection<String>`	`getStringsWithPrefix(String prefix)`
`String`	`getText(String name)`
`void`	`onClearCache(ClearCacheEvent event)`
`void`	`refresh()` Refresh application properties object by refreshing the PropertiesManager
`void`	`setOption(String key, boolean value)` Sets the boolean application property.
`void`	`setString(String key, String value)` Sets the string application property.
`void`	`setText(String key, String value)` Set the text application property.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApplicationPropertiesImpl
```
public ApplicationPropertiesImpl(ApplicationPropertiesStore applicationPropertiesStore)
```
- Method Detail
  - onClearCache
```
@EventListener
public void onClearCache(ClearCacheEvent event)
```
  - getText
```
public String getText(String name)
```
    Specified by:
    
    getText in interface ApplicationProperties
  - getString
```
@Nullable
public String getString(String name)
```
    Description copied from interface: ApplicationProperties
    
    Returns the value of the given key.
    
    Specified by:
    
    getString in interface ApplicationProperties
    
    Parameters:
    
    name - the key to retrieve
    
    Returns:
    
    the value of the key; may be null or an empty String
  - getDefaultKeys
```
public Collection<String> getDefaultKeys()
```
    Description copied from interface: ApplicationProperties
    
    Get all the keys from the default properties
    
    Specified by:
    
    getDefaultKeys in interface ApplicationProperties
  - getDefaultBackedString
```
public String getDefaultBackedString(String name)
```
    Description copied from interface: ApplicationProperties
    
    Get the property from the application properties, but if not found, try to get from the default properties file.
    
    Specified by:
    
    getDefaultBackedString in interface ApplicationProperties
  - getDefaultBackedText
```
public String getDefaultBackedText(String name)
```
    Description copied from interface: ApplicationProperties
    
    Get the property from the application properties, but if not found, try to get from the default properties file.
    
    Specified by:
    
    getDefaultBackedText in interface ApplicationProperties
  - getDefaultString
```
public String getDefaultString(String name)
```
    Description copied from interface: ApplicationProperties
    
    Get the default property (if the property is not set)
    
    Specified by:
    
    getDefaultString in interface ApplicationProperties
    
    Parameters:
    
    name - the name of the property.
  - getOption
```
public boolean getOption(String key)
```
    Description copied from interface: ApplicationProperties
    
    Get the option from the application properties, but if not found, try to get from the default properties file.
    
    Specified by:
    
    getOption in interface ApplicationProperties
  - getKeys
```
public Collection<String> getKeys()
```
    Specified by:
    
    getKeys in interface ApplicationProperties
  - asMap
```
public Map<String,Object> asMap()
```
    Description copied from interface: ApplicationProperties
    
    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()
    WARNING: This method is somewhat expensive. Do not use it unless you really are doing something with all of the application properties, such as for the system information page. If you are just retrieving a single property, then use one of the get methods instead. For most properties, ApplicationProperties.getDefaultBackedString(String) or ApplicationProperties.getOption(String) will be the best choice.
    
    Specified by:
    
    asMap in interface ApplicationProperties
    
    Returns:
    
    a map of key to actual value object
  - setString
```
public void setString(String key,
                      String value)
```
    Description copied from interface: ApplicationProperties
    
    Sets the string application property. Once the property is set, this method publishes an instance of StringApplicationPropertySetEvent.
    
    Specified by:
    
    setString in interface ApplicationProperties
    
    Parameters:
    
    key - the key of the application property.
    
    value - the value of the application property.
  - setText
```
public void setText(String key,
                    String value)
```
    Description copied from interface: ApplicationProperties
    
    Set the text application property. Once the property is set, this method publishes an instance of StringApplicationPropertySetEvent.
    
    Specified by:
    
    setText in interface ApplicationProperties
    
    Parameters:
    
    key - the key of the application property.
    
    value - the value of the application property.
  - setOption
```
public void setOption(String key,
                      boolean value)
```
    Description copied from interface: ApplicationProperties
    
    Sets the boolean application property. Once the property is set, this method publishes an instance of BooleanApplicationPropertySetEvent.
    
    Specified by:
    
    setOption in interface ApplicationProperties
    
    Parameters:
    
    key - the key of the application property.
    
    value - the value of the application property.
  - getEncoding
```
public String getEncoding()
```
    Description copied from interface: ApplicationProperties
    
    Returns the encoding to be used by JIRA from the application properties. If application properties are not available, it returns UTF-8 by default.
    
    Specified by:
    
    getEncoding in interface ApplicationProperties
  - getMailEncoding
```
public String getMailEncoding()
```
    Description copied from interface: ApplicationProperties
    
    Convenience method to get the email encoding
    
    Specified by:
    
    getMailEncoding in interface ApplicationProperties
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface ApplicationProperties
  - refresh
```
public void refresh()
```
    Description copied from interface: ApplicationProperties
    
    Refresh application properties object by refreshing the PropertiesManager
    
    Specified by:
    
    refresh in interface ApplicationProperties
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Description copied from interface: ApplicationProperties
    
    Returns the default Locale set up on the JIRA instance.
    
    Specified by:
    
    getDefaultLocale in interface ApplicationProperties
    
    Returns:
    
    the default locale.
  - getStringsWithPrefix
```
public Collection<String> getStringsWithPrefix(String prefix)
```
    Specified by:
    
    getStringsWithPrefix in interface ApplicationProperties

Class ApplicationPropertiesImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

Constructor Detail

ApplicationPropertiesImpl

Method Detail

onClearCache

getText

getString

getDefaultKeys

getDefaultBackedString

getDefaultBackedText

getDefaultString

getOption

getKeys

asMap

setString

setText

setOption

getEncoding

getMailEncoding

getContentType

refresh

toString

getDefaultLocale

getStringsWithPrefix