Class OptionConverter
java.lang.Object
org.apache.logging.log4j.core.util.OptionConverter
A convenience class to convert property values to specific types.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String[]concatenateArrays(String[] l, String[] r) static Stringstatic StringfindAndSubst(String key, Properties props) Find the value corresponding tokeyinprops.static ObjectinstantiateByClassName(String className, Class<?> superClass, Object defaultValue) Instantiate an object given a class name.static ObjectinstantiateByKey(Properties props, String key, Class<?> superClass, Object defaultValue) static StringsubstVars(String val, Properties props) Perform variable substitution in stringvalfrom the values of keys found in the system propeties.private static StringsubstVars(String val, Properties props, List<String> keys) static booleanIfvalueis "true", thentrueis returned.static longtoFileSize(String value, long defaultValue) static intConvert the String value to an int.static Level
-
Field Details
-
LOGGER
-
DELIM_START
- See Also:
-
DELIM_STOP
private static final char DELIM_STOP- See Also:
-
DELIM_START_LEN
private static final int DELIM_START_LEN- See Also:
-
DELIM_STOP_LEN
private static final int DELIM_STOP_LEN- See Also:
-
ONE_K
private static final int ONE_K- See Also:
-
-
Constructor Details
-
OptionConverter
private OptionConverter()OptionConverter is a static class.
-
-
Method Details
-
concatenateArrays
-
convertSpecialChars
-
instantiateByKey
public static Object instantiateByKey(Properties props, String key, Class<?> superClass, Object defaultValue) -
toBoolean
Ifvalueis "true", thentrueis returned. Ifvalueis "false", thenfalseis returned. Otherwise,defaultis returned.Case of value is unimportant.
- Parameters:
value- The value to convert.defaultValue- The default value.- Returns:
- true or false, depending on the value and/or default.
-
toInt
Convert the String value to an int.- Parameters:
value- The value as a String.defaultValue- The default value.- Returns:
- The value as an int.
-
toLevel
-
toFileSize
- Parameters:
value- The size of the file as a String.defaultValue- The default value.- Returns:
- The size of the file as a long.
-
findAndSubst
Find the value corresponding tokeyinprops. Then perform variable substitution on the found value.- Parameters:
key- The key to locate.props- The properties.- Returns:
- The String after substitution.
-
instantiateByClassName
public static Object instantiateByClassName(String className, Class<?> superClass, Object defaultValue) Instantiate an object given a class name. Check that theclassNameis a subclass ofsuperClass. If that test fails or the object could not be instantiated, thendefaultValueis 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:
- The created object.
-
substVars
Perform variable substitution in stringvalfrom the values of keys found in the system propeties.The variable substitution delimiters 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
sto "Value of key is value.".If no value could be found for the specified key, then the
propsparameter is searched, if the value could not be found there, then substitution defaults to the empty string.For example, if system properties contains no value for the key "inexistentKey", then the call
String s = OptionConverter.subsVars("Value of inexistentKey is [${inexistentKey}]");will set
sto "Value of inexistentKey is []"An
IllegalArgumentExceptionis thrown ifvalcontains a start delimeter "${" which is not balanced by a stop delimeter "}".- Parameters:
val- The string on which variable substitution is performed.props- The properties to use for substitution.- Returns:
- The String after substitution.
- Throws:
IllegalArgumentException- ifvalis malformed.
-
substVars
private static String substVars(String val, Properties props, List<String> keys) throws IllegalArgumentException - Throws:
IllegalArgumentException
-