Class OptionConverter
- Author:
- Ceki Gülcü, Simon Kitching;, Anders Kristensen
-
Method Summary
Modifier and TypeMethodDescriptionstatic String[]concatanateArrays(String[] l, String[] r) static Stringstatic StringfindAndSubst(String key, Properties props) Find the value corresponding tokeyinprops.static StringgetSystemProperty(String key, String def) Very similar toSystem.getPropertyexcept that theSecurityExceptionis hidden.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 voidselectAndConfigure(InputStream inputStream, String clazz, LoggerRepository hierarchy) Configure log4j given anInputStream.static voidselectAndConfigure(URL url, String clazz, LoggerRepository hierarchy) Configure log4j given a URL.static StringsubstVars(String val, Properties props) Perform variable substitution in stringvalfrom the values of keys found in the system propeties.static booleanIfvalueis "true", thentrueis returned.static longtoFileSize(String value, long dEfault) static intstatic LevelConverts a standard or custom priority level to a Level object.
-
Method Details
-
concatanateArrays
-
convertSpecialChars
-
getSystemProperty
Very similar toSystem.getPropertyexcept that theSecurityExceptionis 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 Object instantiateByKey(Properties props, String key, Class superClass, Object defaultValue) -
toBoolean
Ifvalueis "true", thentrueis returned. Ifvalueis "false", thentrueis returned. Otherwise,defaultis returned.Case of value is unimportant.
-
toInt
-
toLevel
Converts a standard or custom priority level to a Level object.If
valueis of form "level#classname", then the specified class' toLevel method is called to process the specified level string; if no '#' character is present, then the defaultLevelclass is used to process the level value.As a special case, if the
valueparameter is equal to the string "NULL", then the valuenullwill be returned.If any error occurs while converting the value to a level, the
defaultValueparameter, which may benull, is returned.Case of
valueis insignificant for the level level, but is significant for the class name part, if present.- Since:
- 1.1
-
toFileSize
-
findAndSubst
Find the value corresponding tokeyinprops. Then perform variable substitution on the found value. -
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
-
substVars
Perform variable substitution in stringvalfrom 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
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 propeties 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 "}".Author Avy Sharell
- Parameters:
val- The string on which variable substitution is performed.- Throws:
IllegalArgumentException- ifvalis malformed.
-
selectAndConfigure
public static void selectAndConfigure(InputStream inputStream, String clazz, LoggerRepository hierarchy) Configure log4j given anInputStream.The InputStream will be interpreted by a new instance of a log4j configurator.
All configurations steps are taken on the
hierarchypassed as a parameter.- Parameters:
inputStream- The configuration input stream.clazz- The class name, of the log4j configurator which will parse theinputStream. This must be a subclass ofConfigurator, or null. If this value is null then a default configurator ofPropertyConfiguratoris used.hierarchy- TheHierarchyto act on.- Since:
- 1.2.17
-
selectAndConfigure
Configure log4j given a URL.The url must point to a file or resource which will be interpreted by a new instance of a log4j configurator.
All configurations steps are taken on the
hierarchypassed as a parameter.- Parameters:
url- The location of the configuration file or resource.clazz- The classname, of the log4j configurator which will parse the file or resource aturl. This must be a subclass ofConfigurator, or null. If this value is null then a default configurator ofPropertyConfiguratoris used, unless the filename pointed to byurlends in '.xml', in which caseDOMConfiguratoris used.hierarchy- TheHierarchyto act on.- Since:
- 1.1.4
-