Module com.io7m.jproperties.core

Package com.io7m.jproperties

Class JProperties

java.lang.Object

com.io7m.jproperties.JProperties

public final class JProperties
extends Object

Type-safe interface to Properties.

Method Summary

Modifier and Type	Method	Description
static Properties	fromFile(File file)	Load properties from the given file.
static BigDecimal	getBigDecimal(Properties properties, String key)	Returns the real value associated with key in the properties referenced by properties.
static BigDecimal	getBigDecimalOptional(Properties properties, String key, BigDecimal other)	Returns the real value associated with key in the properties referenced by properties if it exists, otherwise returns the given default value.
static BigInteger	getBigInteger(Properties properties, String key)	Returns the integer value associated with key in the properties referenced by properties.
static BigInteger	getBigIntegerOptional(Properties properties, String key, BigInteger other)	Returns the integer value associated with key in the properties referenced by properties if it exists, otherwise returns other.
static boolean	getBoolean(Properties properties, String key)	Returns the boolean value associated with key in the properties referenced by properties.
static boolean	getBooleanOptional(Properties properties, String key, boolean other)	Returns the boolean value associated with key in the properties referenced by properties if it exists, otherwise returns other.
static String	getString(Properties properties, String key)	Returns the string value associated with key in the properties referenced by props
static String	getStringOptional(Properties properties, String key, String other)	Returns the string value associated with key in the properties referenced by props if it exists, otherwise returns other.

Methods inherited from class java.lang.Object

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

Method Detail

fromFile

public static Properties fromFile(File file)
                           throws IOException

Load properties from the given file.

Parameters:

file - The file.

Returns:

The loaded properties.

Throws:

IOException - On I/O errors.

getBigDecimal

public static BigDecimal getBigDecimal(Properties properties,
                                       String key)
                                throws JPropertyNonexistent,
                                       JPropertyIncorrectType

Returns the real value associated with key in the properties referenced by properties.

Parameters:

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as an real.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as a real.

getBigDecimalOptional

public static BigDecimal getBigDecimalOptional(Properties properties,
                                               String key,
                                               BigDecimal other)
                                        throws JPropertyNonexistent,
                                               JPropertyIncorrectType

Returns the real value associated with key in the properties referenced by properties if it exists, otherwise returns the given default value.

Parameters:

other - The default value

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as an real.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as a real.

getBigInteger

public static BigInteger getBigInteger(Properties properties,
                                       String key)
                                throws JPropertyNonexistent,
                                       JPropertyIncorrectType

Returns the integer value associated with key in the properties referenced by properties.

Parameters:

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as an integer.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as an integer.

getBigIntegerOptional

public static BigInteger getBigIntegerOptional(Properties properties,
                                               String key,
                                               BigInteger other)
                                        throws JPropertyNonexistent,
                                               JPropertyIncorrectType

Returns the integer value associated with key in the properties referenced by properties if it exists, otherwise returns other.

Parameters:

other - The default value

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as an integer.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as an integer.

getBoolean

public static boolean getBoolean(Properties properties,
                                 String key)
                          throws JPropertyNonexistent,
                                 JPropertyIncorrectType

Returns the boolean value associated with key in the properties referenced by properties.

A boolean value is syntactically the strings "true" or "false", case insensitive.

Parameters:

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as a boolean.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as a boolean.

getBooleanOptional

public static boolean getBooleanOptional(Properties properties,
                                         String key,
                                         boolean other)
                                  throws JPropertyNonexistent,
                                         JPropertyIncorrectType

Returns the boolean value associated with key in the properties referenced by properties if it exists, otherwise returns other.

A boolean value is syntactically the strings "true" or "false", case insensitive.

Parameters:

other - The default value

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the key, parsed as a boolean.

Throws:

JPropertyNonexistent - If the key does not exist in the given properties.

JPropertyIncorrectType - If the value associated with the key cannot be parsed as a boolean.

getString

public static String getString(Properties properties,
                               String key)
                        throws JPropertyNonexistent

Returns the string value associated with key in the properties referenced by props

Parameters:

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the given key

Throws:

JPropertyNonexistent - If the given key is not present in the given properties.

getStringOptional

public static String getStringOptional(Properties properties,
                                       String key,
                                       String other)
                                throws JPropertyNonexistent

Returns the string value associated with key in the properties referenced by props if it exists, otherwise returns other.

Parameters:

other - The default value

properties - The loaded properties.

key - The requested key.

Returns:

The value associated with the given key

Throws:

JPropertyNonexistent - If the given key is not present in the given properties.