|
Log4j 1.1b7 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.log4j.helpers.OptionConverter
A convenience class to convert property values to specific types.
Method Summary | |
static String[] |
concatanateArrays(String[] l,
String[] r)
|
static String |
convertSpecialChars(String s)
|
static String |
findAndSubst(String key,
Properties props)
Find the value corresponding to key in
props . |
static String |
getSystemProperty(String key,
String def)
Very similar to System.getProperty except
that the SecurityException is hidden. |
static Object |
instantiateByClassName(String className,
Class superClass,
Object defaultValue)
Instantiate an object given a class name. |
static Object |
instantiateByKey(Properties props,
String key,
Class superClass,
Object defaultValue)
|
static void |
selectAndConfigure(URL url,
Hierarchy hierarchy)
Configure log4j given a URL. |
static String |
substVars(String val,
Properties props)
Perform variable substitution in string val from the
values of keys found in the system propeties.
|
static boolean |
toBoolean(String value,
boolean dEfault)
If value is "true", then true is
returned. |
static long |
toFileSize(String value,
long dEfault)
|
static int |
toInt(String value,
int dEfault)
|
static Priority |
toPriority(String value,
Priority defaultValue)
Converts a standard or custom priority level to a Priority object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static String[] concatanateArrays(String[] l, String[] r)
public static String convertSpecialChars(String s)
public static String getSystemProperty(String key, String def)
System.getProperty
except
that the SecurityException
is hidden.key
- The key to search for.def
- The default value to return.public static Object instantiateByKey(Properties props, String key, Class superClass, Object defaultValue)
public static boolean toBoolean(String value, boolean dEfault)
value
is "true", then true
is
returned. If value
is "false", then
true
is returned. Otherwise, default
is
returned.
Case of value is unimportant.
public static int toInt(String value, int dEfault)
public static Priority toPriority(String value, Priority defaultValue)
If value
is of form
"priority#classname", then the specified class' toPriority method
is called to process the specified priority string; if no '#'
character is present, then the default Priority
class is used to process the priority value.
If any error occurs while converting the value to a priority, the dflt value (which may be null) is returned.
Case of value is unimportant for the priority level, but is significant for any class name part present.
public static long toFileSize(String value, long dEfault)
public static String findAndSubst(String key, Properties props)
key
in
props
. Then perform variable substitution on the
found value.public static Object instantiateByClassName(String className, Class superClass, Object defaultValue)
className
is a subclass of
superClass
. If that test fails or the object could
not be instantiated, then defaultValue
is returned.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-fulfillmentpublic static String substVars(String val, Properties props) throws IllegalArgumentException
val
from the
values of keys found in the system propeties.
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 IllegalArgumentException
is thrown if
val
contains a start delimeter "${" which is not
balanced by a stop delimeter "}".
Author Avy Sharell
val
- The string on which variable substitution is performed.IllegalArgumentException
- if val
is malformed.public static void selectAndConfigure(URL url, Hierarchy hierarchy)
The URL format is important. Its reference part is taken as the class name of the configurator. For example, if you invoke your application using the command line
java -Dlog4j.configuration=file:/temp/myconfig.xyz#com.myCompany.myConfiguratorthen the log4j will be configured by a new instance of
com.myCompany.myConfigurator
by interpreting the
file referenced by file:/temp/myconfig.xyz
. The
configurator you specify must implement the Configurator
interface.
If the URL has no reference part, then the PropertyConfigurator
will parse the URL. However, if the URL
ends with a ".xml" extension, then the DOMConfigurator
will be used to parse the URL.
All configurations steps are taken on the
hierarchy
passed as parameter.
|
Log4j 1.1b7 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |