org.apache.gobblin.util

Class PropertiesUtils

java.lang.Object

org.apache.gobblin.util.PropertiesUtils

public class PropertiesUtils
extends Object

A utility class for Properties objects.

Constructor Summary

Constructors

Constructor and Description
PropertiesUtils()

Method Summary

Modifier and Type	Method and Description
static Properties	combineProperties(Properties... properties) Combine a variable number of Properties into a single Properties.
static Properties	deserialize(String serialized)
static Properties	extractPropertiesWithPrefix(Properties properties, com.google.common.base.Optional<String> prefix) Extract all the keys that start with a prefix in Properties to a new Properties instance.
static Properties	extractPropertiesWithPrefixAfterRemovingPrefix(Properties properties, String prefix) Extract all the keys that start with a prefix in Properties to a new Properties instance.
static boolean	getPropAsBoolean(Properties properties, String key, String defaultValue)
static int	getPropAsInt(Properties properties, String key, int defaultValue)
static List<String>	getPropAsList(Properties properties, String key) Get the value of a comma separated property as a List of strings.
static List<String>	getPropAsList(Properties properties, String key, String def) Get the value of a property as a list of strings, using the given default value if the property is not set.
static long	getPropAsLong(Properties properties, String key, long defaultValue)
static List<String>	getValuesAsList(Properties properties, com.google.common.base.Optional<String> prefix) Extract all the values whose keys start with a prefix
static String	prettyPrintProperties(Properties properties)
static Map<String,?>	propsToStringKeyMap(Properties properties) Converts a Properties object to a Map where each key is a String.
static String	serialize(Properties properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesUtils

public PropertiesUtils()

Method Detail

combineProperties

public static Properties combineProperties(Properties... properties)

Combine a variable number of Properties into a single Properties.

propsToStringKeyMap

public static Map<String,?> propsToStringKeyMap(Properties properties)

Converts a Properties object to a Map where each key is a String.

getPropAsBoolean

public static boolean getPropAsBoolean(Properties properties,
                                       String key,
                                       String defaultValue)

getPropAsInt

public static int getPropAsInt(Properties properties,
                               String key,
                               int defaultValue)

getPropAsLong

public static long getPropAsLong(Properties properties,
                                 String key,
                                 long defaultValue)

getPropAsList

public static List<String> getPropAsList(Properties properties,
                                         String key)

Get the value of a comma separated property as a List of strings.

Parameters:

key - property key

Returns:

value associated with the key as a List of strings

getValuesAsList

public static List<String> getValuesAsList(Properties properties,
                                           com.google.common.base.Optional<String> prefix)

Extract all the values whose keys start with a prefix

Parameters:

properties - the given Properties instance

prefix - of keys to be extracted

Returns:

a list of values in the properties

getPropAsList

public static List<String> getPropAsList(Properties properties,
                                         String key,
                                         String def)

Get the value of a property as a list of strings, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

value (the default value if the property is not set) associated with the key as a list of strings

extractPropertiesWithPrefix

public static Properties extractPropertiesWithPrefix(Properties properties,
                                                     com.google.common.base.Optional<String> prefix)

Extract all the keys that start with a prefix in Properties to a new Properties instance.

Parameters:

properties - the given Properties instance

prefix - of keys to be extracted

Returns:

a Properties instance

extractPropertiesWithPrefixAfterRemovingPrefix

public static Properties extractPropertiesWithPrefixAfterRemovingPrefix(Properties properties,
                                                                        String prefix)

Extract all the keys that start with a prefix in Properties to a new Properties instance. It removes the prefix from the properties.

Parameters:

properties - the given Properties instance

prefix - of keys to be extracted

Returns:

a Properties instance

serialize

public static String serialize(Properties properties)
                        throws IOException

Throws:

IOException

deserialize

public static Properties deserialize(String serialized)
                              throws IOException

Throws:

IOException

prettyPrintProperties

public static String prettyPrintProperties(Properties properties)