com.neeve.util

Class UtlProps

java.lang.Object

com.neeve.util.UtlProps

public final class UtlProps
extends Object

Utility class containing methods to work with properties. This class IS supported for use by end users.

Constructor Summary

Constructors

Constructor and Description
UtlProps()

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	deserialize(String str) Deerialize a property table from a string
static Properties	getSubProps(Properties props, String prefix, boolean removePrefix, Properties subProps) Gets a new set of roperties starting with the given prefix from the provided properties set.
static <T extends Map<String,Object>> T	getSubProps(Properties props, String prefix, boolean removePrefix, T subProps) Gets a new set of roperties starting with the given prefix from the provided properties set.
static Object	getValue(Map<String,Object> props, String name) Get the value of a property from a property table.
static boolean	getValue(Map<String,Object> props, String name, boolean defValue) Convenience method to return a property value as a boolean value
static double	getValue(Map<String,Object> props, String name, double defValue) Convenience method to return a property value as a numeric value
static int	getValue(Map<String,Object> props, String name, int defValue) Convenience method to return a property value as a numeric value
static short	getValue(Map<String,Object> props, String name, short defValue) Convenience method to return a property value as a numeric value
static String	getValue(Map<String,Object> props, String name, String defValue) Convenience method to return a property value as a String value
static String	getValue(Properties props, String name) Get the value of a property from a property table.
static boolean	getValue(Properties props, String name, boolean defValue) Convenience method to return a property value as a boolean value
static double	getValue(Properties props, String name, double defValue) Convenience method to return a property value as a numeric value
static int	getValue(Properties props, String name, int defValue) Convenience method to return a property value as an int value
static short	getValue(Properties props, String name, short defValue) Convenience method to return a property value as a short value
static String	getValue(Properties props, String name, String defValue) Convenience method to return a property value as a String value
static void	serialize(Properties props, StringBuilder builder) Serialize a property table to a string

Methods inherited from class java.lang.Object

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

Constructor Detail

UtlProps

public UtlProps()

Method Detail

getValue

public static final String getValue(Properties props,
              String name)

Get the value of a property from a property table.

Parameters:

props - The property table

name - The property name

Returns:

Returns the property value

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final String getValue(Properties props,
              String name,
              String defValue)

Convenience method to return a property value as a String value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a String value.

This method is a convenience method that returns a property value as a string value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final short getValue(Properties props,
             String name,
             short defValue)

Convenience method to return a property value as a short value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final int getValue(Properties props,
           String name,
           int defValue)

Convenience method to return a property value as an int value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final double getValue(Properties props,
              String name,
              double defValue)

Convenience method to return a property value as a numeric value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final boolean getValue(Properties props,
               String name,
               boolean defValue)

Convenience method to return a property value as a boolean value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a boolean value.

This method is a convenience method that returns a property value as a boolean value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final Object getValue(Map<String,Object> props,
              String name)

Get the value of a property from a property table.

Parameters:

props - The property table.

name - The property name

Returns:

Returns the property value

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final String getValue(Map<String,Object> props,
              String name,
              String defValue)

Convenience method to return a property value as a String value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a String value.

This method is a convenience method that returns a property value as a string value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final short getValue(Map<String,Object> props,
             String name,
             short defValue)

Convenience method to return a property value as a numeric value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final int getValue(Map<String,Object> props,
           String name,
           int defValue)

Convenience method to return a property value as a numeric value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final double getValue(Map<String,Object> props,
              String name,
              double defValue)

Convenience method to return a property value as a numeric value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a numeric value.

This method is a convenience method that returns a property value as a numeric value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

getValue

public static final boolean getValue(Map<String,Object> props,
               String name,
               boolean defValue)

Convenience method to return a property value as a boolean value

Parameters:

props - The property table

name - The property name

defValue - The default property value to return in case the property could not be found in the property table.

Returns:

Returns the property value as a boolean value.

This method is a convenience method that returns a property value as a boolean value. It uses getValue(java.util.Properties, java.lang.String) to retrieve the property value. The default value is returned in case the no property with the provided name exists in the property table.

Threading:

This method is safe for concurrent access by multiple threads

serialize

public static final void serialize(Properties props,
             StringBuilder builder)

Serialize a property table to a string

Parameters:

props - The property table to serialize

builder - The string builder to serialize it to.

Threading:

This method is safe for concurrent access by multiple threads

deserialize

public static final Properties deserialize(String str)

Deerialize a property table from a string

Parameters:

str - The string to deserialize it from.

Threading:

This method is safe for concurrent access by multiple threads

getSubProps

public static final <T extends Map<String,Object>> T getSubProps(Properties props,
                                           String prefix,
                                           boolean removePrefix,
                                           T subProps)

Gets a new set of roperties starting with the given prefix from the provided properties set.

Given:

• foo.bar=val0
• prop.foo=val1
• foo.foo=val2
  This method would return
  • bar=val0
  • foo=val2
    when called with a prefix of "foo" and removePrefix = true;

Parameters:

props - The properties from which to extract the prefixed properties.

prefix - The prefix to match.

removePrefix - Whether the prefix is removed.

subProps - The target map into which to add the matching properties.

Returns:

The set of properties starting with the given prefix (with the prefix removed).

getSubProps

public static final Properties getSubProps(Properties props,
                     String prefix,
                     boolean removePrefix,
                     Properties subProps)

Gets a new set of roperties starting with the given prefix from the provided properties set.

Given:

• foo.bar=val0
• prop.foo=val1
• foo.foo=val2

This method would return

• bar=val0
• foo=val2

when called with a prefix of "foo".

Parameters:

props - The properties from which to extract the prefixed properties.

prefix - The prefix to match.

removePrefix - Whether the prefix is removed.

subProps - The target map into which to add the matching properties.

Returns:

The set of properties starting with the given prefix (with the prefix removed).