com.atlassian.bamboo.utils

Class ConfigUtils

java.lang.Object

com.atlassian.bamboo.utils.ConfigUtils

public class ConfigUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAMBOO_DELIMITER_PARSING_DISABLED
static String	FIRST_ELEMENT_IN_LIST
static String	SEPARATOR

Method Summary

Modifier and Type	Method and Description
static void	addMapToBuilConfiguration(String mapKey, Map<String,String> map, org.apache.commons.configuration.HierarchicalConfiguration configuration) Deprecated. since 5.0, use addMapToConfiguration(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, org.apache.commons.configuration.HierarchicalConfiguration)
static void	addMapToConfiguration(String mapConfigKey, Map<String,String> map, org.apache.commons.configuration.HierarchicalConfiguration configuration)
static void	addMapToConfiguration(String mapConfigKey, String entryConfigKey, Map<String,String> map, org.apache.commons.configuration.HierarchicalConfiguration configuration)
static void	addNodeAt(org.apache.commons.configuration.HierarchicalConfiguration configuration, String rootPath, org.apache.commons.configuration.HierarchicalConfiguration configToAdd)
static void	addNodesAt(org.apache.commons.configuration.HierarchicalConfiguration config, String rootPath, org.apache.commons.configuration.HierarchicalConfiguration configToAdd)
static Map<String,String>	asMap(org.apache.commons.configuration.Configuration config)
static Map<String,String>	asMap(org.apache.commons.configuration.Configuration config, String filter)
static Map<String,Object>	asObjectMap(org.apache.commons.configuration.Configuration config)
static Map<String,Object>	asObjectMap(org.apache.commons.configuration.Configuration config, String filter)
static String	asXmlString(org.apache.commons.configuration.HierarchicalConfiguration hierarchicalConfiguration) Deprecated. doesn't preserve bambooDelimiterParsing disabled property correctly. Avoid, especially when manipulating build configuration. Use BuildConfiguration.asXml() instead.
static String	asXmlString(org.apache.commons.configuration.XMLConfiguration configuration)
static void	copyMapToConfig(Map<String,String> map, org.apache.commons.configuration.Configuration config)
static void	copyNodes(org.apache.commons.configuration.HierarchicalConfiguration sourceConfig, org.apache.commons.configuration.HierarchicalConfiguration targetConfig)
static void	copyNodes(org.apache.commons.configuration.HierarchicalConfiguration sourceConfig, org.apache.commons.configuration.HierarchicalConfiguration targetConfig, String key)
static void	copyObjectMapToConfig(Map<String,Object> map, org.apache.commons.configuration.Configuration config)
static org.apache.commons.configuration.HierarchicalConfiguration	fromMap(Map<String,?> map)
static <T extends org.apache.commons.configuration.Configuration> T	fromMap(Map<String,?> map, Supplier<T> configSupplier)
static Map<String,String>	getMapFromConfiguration(String mapConfigKey, org.apache.commons.configuration.HierarchicalConfiguration configuration)
static Map<String,String>	getMapFromConfiguration(String mapConfigKey, String entryConfigKey, org.apache.commons.configuration.HierarchicalConfiguration configuration)
static <T> List<T>	getPropertyAsList(org.apache.commons.configuration.HierarchicalConfiguration configuration, String propertyName, Class<T> propertyType) Returns a given property from the configuration as a list of given type.
static <T> List<T>	getPropertyAsList(Map<String,Object> configuration, String propertyName, Class<T> propertyType) Returns a given property from the configuration as a list of given type.
static org.apache.commons.configuration.XMLConfiguration	getXmlConfigFromXmlString(String xmlData)
static org.apache.commons.configuration.XMLConfiguration	getXmlConfigFromXmlString(String xmlData, boolean delimiterParsingDisabled) Deprecated. since 5.2 use $getXmlConfigFromXmlString(java.lang.String)
static org.apache.commons.configuration.XMLConfiguration	newConfiguration()
static org.apache.commons.configuration.XMLConfiguration	newConfiguration(boolean isDelimiterParsingDisabled)
static org.apache.commons.configuration.XMLConfiguration	newConfiguration(org.apache.commons.configuration.HierarchicalConfiguration configuration)
static void	sanitiseAndSave(org.apache.commons.configuration.XMLConfiguration configuration, Writer buildXml) Deprecated. since 5.7 use CommonsConfigUtils.sanitiseAndSave(org.apache.commons.configuration.XMLConfiguration, java.io.Writer) instead
static Map<String,Long>	toLongMap(Map<String,String> stringMap)
static Map<String,String>	toStringMap(Map<String,?> objectsMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BAMBOO_DELIMITER_PARSING_DISABLED

public static final String BAMBOO_DELIMITER_PARSING_DISABLED

FIRST_ELEMENT_IN_LIST

public static final String FIRST_ELEMENT_IN_LIST

SEPARATOR

public static final String SEPARATOR

Method Detail

copyMapToConfig

public static void copyMapToConfig(@NotNull
                                   Map<String,String> map,
                                   @NotNull
                                   org.apache.commons.configuration.Configuration config)

copyObjectMapToConfig

public static void copyObjectMapToConfig(@NotNull
                                         Map<String,Object> map,
                                         @NotNull
                                         org.apache.commons.configuration.Configuration config)

fromMap

@NotNull
public static org.apache.commons.configuration.HierarchicalConfiguration fromMap(@NotNull
                                                                                          Map<String,?> map)

fromMap

@NotNull
public static <T extends org.apache.commons.configuration.Configuration> T fromMap(@NotNull
                                                                                            Map<String,?> map,
                                                                                            @NotNull
                                                                                            Supplier<T> configSupplier)

asMap

@NotNull
public static Map<String,String> asMap(@NotNull
                                                org.apache.commons.configuration.Configuration config)

asMap

@NotNull
public static Map<String,String> asMap(@NotNull
                                                org.apache.commons.configuration.Configuration config,
                                                @Nullable
                                                String filter)

asObjectMap

public static Map<String,Object> asObjectMap(@NotNull
                                             org.apache.commons.configuration.Configuration config)

asObjectMap

@NotNull
public static Map<String,Object> asObjectMap(@NotNull
                                                      org.apache.commons.configuration.Configuration config,
                                                      @Nullable
                                                      String filter)

addNodesAt

public static void addNodesAt(org.apache.commons.configuration.HierarchicalConfiguration config,
                              String rootPath,
                              org.apache.commons.configuration.HierarchicalConfiguration configToAdd)

addNodeAt

public static void addNodeAt(org.apache.commons.configuration.HierarchicalConfiguration configuration,
                             String rootPath,
                             org.apache.commons.configuration.HierarchicalConfiguration configToAdd)

addMapToConfiguration

public static void addMapToConfiguration(@NotNull
                                         String mapConfigKey,
                                         @NotNull
                                         String entryConfigKey,
                                         @NotNull
                                         Map<String,String> map,
                                         @NotNull
                                         org.apache.commons.configuration.HierarchicalConfiguration configuration)

addMapToConfiguration

public static void addMapToConfiguration(@NotNull
                                         String mapConfigKey,
                                         @NotNull
                                         Map<String,String> map,
                                         @NotNull
                                         org.apache.commons.configuration.HierarchicalConfiguration configuration)

addMapToBuilConfiguration

@Deprecated
public static void addMapToBuilConfiguration(@NotNull
                                                         String mapKey,
                                                         @NotNull
                                                         Map<String,String> map,
                                                         @NotNull
                                                         org.apache.commons.configuration.HierarchicalConfiguration configuration)

Deprecated. since 5.0, use addMapToConfiguration(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, org.apache.commons.configuration.HierarchicalConfiguration)

getMapFromConfiguration

@NotNull
public static Map<String,String> getMapFromConfiguration(@NotNull
                                                                  String mapConfigKey,
                                                                  @NotNull
                                                                  String entryConfigKey,
                                                                  @NotNull
                                                                  org.apache.commons.configuration.HierarchicalConfiguration configuration)

getMapFromConfiguration

@NotNull
public static Map<String,String> getMapFromConfiguration(@NotNull
                                                                  String mapConfigKey,
                                                                  @NotNull
                                                                  org.apache.commons.configuration.HierarchicalConfiguration configuration)

toStringMap

@NotNull
public static Map<String,String> toStringMap(@NotNull
                                                      Map<String,?> objectsMap)

toLongMap

@NotNull
public static Map<String,Long> toLongMap(@NotNull
                                                  Map<String,String> stringMap)
                                           throws NumberFormatException

Throws:

NumberFormatException

sanitiseAndSave

@Deprecated
public static void sanitiseAndSave(@NotNull
                                               org.apache.commons.configuration.XMLConfiguration configuration,
                                               @NotNull
                                               Writer buildXml)
                                        throws org.apache.commons.configuration.ConfigurationException

Deprecated. since 5.7 use CommonsConfigUtils.sanitiseAndSave(org.apache.commons.configuration.XMLConfiguration, java.io.Writer) instead

Throws:

org.apache.commons.configuration.ConfigurationException

asXmlString

@Deprecated
public static String asXmlString(@NotNull
                                             org.apache.commons.configuration.HierarchicalConfiguration hierarchicalConfiguration)

Deprecated. doesn't preserve bambooDelimiterParsing disabled property correctly. Avoid, especially when manipulating build configuration. Use BuildConfiguration.asXml() instead.

asXmlString

@NotNull
public static String asXmlString(@NotNull
                                          org.apache.commons.configuration.XMLConfiguration configuration)

getXmlConfigFromXmlString

@NotNull
public static org.apache.commons.configuration.XMLConfiguration getXmlConfigFromXmlString(@NotNull
                                                                                                   String xmlData)

getXmlConfigFromXmlString

@Deprecated
 @NotNull
public static org.apache.commons.configuration.XMLConfiguration getXmlConfigFromXmlString(@NotNull
                                                                                                                String xmlData,
                                                                                                                boolean delimiterParsingDisabled)

Deprecated. since 5.2 use $getXmlConfigFromXmlString(java.lang.String)

copyNodes

public static void copyNodes(@NotNull
                             org.apache.commons.configuration.HierarchicalConfiguration sourceConfig,
                             @NotNull
                             org.apache.commons.configuration.HierarchicalConfiguration targetConfig)

copyNodes

public static void copyNodes(@NotNull
                             org.apache.commons.configuration.HierarchicalConfiguration sourceConfig,
                             @NotNull
                             org.apache.commons.configuration.HierarchicalConfiguration targetConfig,
                             @Nullable
                             String key)

newConfiguration

public static org.apache.commons.configuration.XMLConfiguration newConfiguration()

newConfiguration

public static org.apache.commons.configuration.XMLConfiguration newConfiguration(boolean isDelimiterParsingDisabled)

newConfiguration

public static org.apache.commons.configuration.XMLConfiguration newConfiguration(org.apache.commons.configuration.HierarchicalConfiguration configuration)

getPropertyAsList

@NotNull
public static <T> List<T> getPropertyAsList(@NotNull
                                                     org.apache.commons.configuration.HierarchicalConfiguration configuration,
                                                     @NotNull
                                                     String propertyName,
                                                     @NotNull
                                                     Class<T> propertyType)

Returns a given property from the configuration as a list of given type. This method acts as a utility to handle cases when the property value is either an iterable, an array, or a single element (in which case a one-element list is returned). If the property is not found in the configuration, an empty list is returned.

Parameters:

configuration - configuration to fetch property

propertyName - name of the property

propertyType - expected type of each element from the property value as a list

Returns:

a list of values of the specified property from the configuration; may be immutable

Throws:

ClassCastException - if the provided type is incorrect, e.g. the property is a list, but of a different type

getPropertyAsList

@NotNull
public static <T> List<T> getPropertyAsList(@NotNull
                                                     Map<String,Object> configuration,
                                                     @NotNull
                                                     String propertyName,
                                                     @NotNull
                                                     Class<T> propertyType)

Returns a given property from the configuration as a list of given type. This method acts as a utility to handle cases when the property value is either an iterable, an array, or a single element (in which case a one-element list is returned). If the property is not found in the configuration, an empty list is returned.

Parameters:

configuration - configuration to fetch property

propertyName - name of the property

propertyType - expected type of each element from the property value as a list

Returns:

a list of values of the specified property from the configuration; may be immutable

Throws:

ClassCastException - if the provided type is incorrect, e.g. the property is a list, but of a different type