org.apache.jcs.utils.config

Class OptionConverter

java.lang.Object

org.apache.jcs.utils.config.OptionConverter

public class OptionConverter
extends java.lang.Object

This class is based on the log4j class org.apache.log4j.helpers.OptionConverter that was made by Ceki Gülcü Simon Kitching; Avy Sharell (sharell@online.fr) Anders Kristensen Matthieu Verbert (mve@zurich.ibm.com) A convenience class to convert property values to specific types.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String[]	concatanateArrays(java.lang.String[] l, java.lang.String[] r) Combines two arrays.
static java.lang.String	convertSpecialChars(java.lang.String s) Escapes special characters.
static java.lang.String	findAndSubst(java.lang.String key, java.util.Properties props) Find the value corresponding to key in props.
static java.lang.String	getSystemProperty(java.lang.String key, java.lang.String def) Very similar to System.getProperty except that the SecurityException is hidden.
static java.lang.Object	instantiateByClassName(java.lang.String className, java.lang.Class superClass, java.lang.Object defaultValue) Instantiate an object given a class name.
static java.lang.Object	instantiateByKey(java.util.Properties props, java.lang.String key, java.lang.Class superClass, java.lang.Object defaultValue) Creates an object for the className value of the key.
static java.lang.String	substVars(java.lang.String val, java.util.Properties props) Perform variable substitution in string val from the values of keys found in the system properties.
static boolean	toBoolean(java.lang.String value, boolean dEfault) If value is "true", then true is returned.
static long	toFileSize(java.lang.String value, long dEfault)
static int	toInt(java.lang.String value, int dEfault) Converts to int.

Methods inherited from class java.lang.Object

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

Method Detail

concatanateArrays

public static java.lang.String[] concatanateArrays(java.lang.String[] l,
                                   java.lang.String[] r)

Combines two arrays.

Parameters:

l -

r -

Returns:

String[]

convertSpecialChars

public static java.lang.String convertSpecialChars(java.lang.String s)

Escapes special characters.

Parameters:

s -

Returns:

String

getSystemProperty

public static java.lang.String getSystemProperty(java.lang.String key,
                                 java.lang.String def)

Very similar to System.getProperty except that the SecurityException is hidden.

Parameters:

key - The key to search for.

def - The default value to return.

Returns:

the string value of the system property, or the default value if there is no property with that key.

Since:

1.1

instantiateByKey

public static java.lang.Object instantiateByKey(java.util.Properties props,
                                java.lang.String key,
                                java.lang.Class superClass,
                                java.lang.Object defaultValue)

Creates an object for the className value of the key.

Parameters:

props -

key -

superClass -

defaultValue -

Returns:

Object that was created

toBoolean

public static boolean toBoolean(java.lang.String value,
                boolean dEfault)

If value is "true", then true is returned. If value is "false", then true is returned. Otherwise, default is returned.

Case of value is unimportant.

Parameters:

value -

dEfault -

Returns:

Object

toInt

public static int toInt(java.lang.String value,
        int dEfault)

Converts to int.

Parameters:

value -

dEfault -

Returns:

int

toFileSize

public static long toFileSize(java.lang.String value,
              long dEfault)

Parameters:

value -

dEfault -

Returns:

long

findAndSubst

public static java.lang.String findAndSubst(java.lang.String key,
                            java.util.Properties props)

Find the value corresponding to key in props. Then perform variable substitution on the found value.

Parameters:

key -

props -

Returns:

substituted string

instantiateByClassName

public static java.lang.Object instantiateByClassName(java.lang.String className,
                                      java.lang.Class superClass,
                                      java.lang.Object defaultValue)

Instantiate an object given a class name. Check that the className is a subclass of superClass. If that test fails or the object could not be instantiated, then defaultValue is returned.

Parameters:

className - The fully qualified class name of the object to instantiate.

superClass - The class to which the new object should belong.

defaultValue - The object to return in case of non-fulfillment

Returns:

instantiated object

substVars

public static java.lang.String substVars(java.lang.String val,
                         java.util.Properties props)
                                  throws java.lang.IllegalArgumentException

Perform variable substitution in string val from the values of keys found in the system properties.

The variable substitution delimeters are ${ and } .

For example, if the System properties contains "key=value", then the call

 String s = OptionConverter.substituteVars( "Value of key is ${key}." );
 

will set the variable s to "Value of key is value.".

If no value could be found for the specified key, then the props parameter is searched, if the value could not be found there, then substitution defaults to the empty string.

For example, if system propeties contains no value for the key "inexistentKey", then the call

 String s = OptionConverter.subsVars( "Value of inexistentKey is [${inexistentKey}]" );
 

will set s to "Value of inexistentKey is []"

An IllegalArgumentExceptionis thrown if val contains a start delimeter "${" which is not balanced by a stop delimeter "}".

Author Avy Sharell

Parameters:

val - The string on which variable substitution is performed.

props -

Returns:

String

Throws:

java.lang.IllegalArgumentException - if val is malformed.