scriptella.text

Class TypedPropertiesSource

java.lang.Object

scriptella.text.TypedPropertiesSource

public class TypedPropertiesSource
extends java.lang.Object

Typed view for properties.

FIXME: Extract interface

Version:

1.1

Author:

Fyodor Kupolov

Constructor Summary

Constructors

Constructor and Description
TypedPropertiesSource(java.util.Map<java.lang.String,?> properties)

Method Summary

Modifier and Type	Method and Description
static TypedPropertiesSource	from(ConnectionParameters connectionParameters) Converts connectionParameters to TypedPropertiesSource.
boolean	getBooleanProperty(java.lang.String name, boolean defaultValue) Parses property value as a boolean flag.
java.lang.String	getCharsetProperty(java.lang.String name) Parses property value as a charset encoding name.
java.util.Set<java.lang.String>	getKeys()
java.util.Locale	getLocaleProperty(java.lang.String name) Parses property value as a locale string.
java.lang.Number	getNumberProperty(java.lang.String name, java.lang.Number defaultValue) Returns numeric value of the property.
java.util.Map<java.lang.String,?>	getProperties()
java.lang.Object	getProperty(java.lang.String name) Convenience method which returns property by name.
java.lang.String	getStringProperty(java.lang.String name) Returns string value of the property.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedPropertiesSource

public TypedPropertiesSource(java.util.Map<java.lang.String,?> properties)

Method Detail

getKeys

public java.util.Set<java.lang.String> getKeys()

getProperty

public java.lang.Object getProperty(java.lang.String name)

Convenience method which returns property by name.

Parameters:

name - property name

Returns:

property value

getStringProperty

public java.lang.String getStringProperty(java.lang.String name)

Returns string value of the property.

Parameters:

name - property name.

Returns:

property value.

getNumberProperty

public java.lang.Number getNumberProperty(java.lang.String name,
                                          java.lang.Number defaultValue)
                                   throws ConfigurationException

Returns numeric value of the property.

Accepts decimal, hexadecimal, and octal numbers if property is String.

Parameters:

name - property name.

defaultValue - default value to use when property omitted.

Returns:

numeric property value.

Throws:

ConfigurationException - if parsing failed.

See Also:

Long.decode(String)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name,
                                  boolean defaultValue)
                           throws ConfigurationException

Parses property value as a boolean flag.

Parameters:

name - property name.

defaultValue - default value to use if connection has no such property.

Returns:

boolean property value.

Throws:

ConfigurationException - if property has unrecognized value.

getCharsetProperty

public java.lang.String getCharsetProperty(java.lang.String name)
                                    throws ConfigurationException

Parses property value as a charset encoding name.

Parameters:

name - property name.

Returns:

value of the property or null if connection has no such property.

Throws:

ConfigurationException - if charset name is unsupported.

getLocaleProperty

public java.util.Locale getLocaleProperty(java.lang.String name)

Parses property value as a locale string.

Parameters:

name - property name.

Returns:

locale or null if property not found or has no value

See Also:

Locale.toString()

getProperties

public java.util.Map<java.lang.String,?> getProperties()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

from

public static TypedPropertiesSource from(ConnectionParameters connectionParameters)

Converts connectionParameters to TypedPropertiesSource. FIXME: This method should not create a new instance, but return an internal delegate used by connection params.

Parameters:

connectionParameters - connection parameters

Returns:

connection parameters as TypedPropertiesSource