|
Apache Log4cxx
Version 2.0.0
|
A convenience class to convert property values to specific types. More...
#include <optionconverter.h>
Static Public Member Functions | |
| static LogString | convertSpecialChars (const LogString &s) |
| static bool | toBoolean (const LogString &value, bool defaultValue) |
The boolean equivalent of value if it is not empty, otherwise defaultValue. | |
| static int | toInt (const LogString &value, int defaultValue) |
The numeric equivalent of value if it is not empty, otherwise defaultValue. | |
| static size_t | toFileSize (const LogString &value, size_t defaultValue) |
The numeric equivalent of value if it is an integer in the range 0 - 2^63, otherwise defaultValue. | |
| static LevelPtr | toLevel (const LogString &value, const LevelPtr &defaultValue) |
The Level indicated by value if recognised otherwise defaultValue. | |
| static LogString | findAndSubst (const LogString &key, const Properties &props) |
Find the value corresponding to key in props. | |
| static LogString | substVars (const LogString &val, const Properties &props) |
Perform variable substitution in string val from the values of keys found in the system propeties. | |
| static LogString | getSystemProperty (const LogString &key, const LogString &def) |
| static ObjectPtr | instantiateByClassName (const LogString &className, const Class &superClass, const ObjectPtr &defaultValue) |
| Instantiate an object given a class name. | |
| static ObjectPtr | instantiateByKey (const Properties &props, const LogString &key, const Class &superClass, const ObjectPtr &defaultValue) |
Instantiate an object using the value in props associated with key as a registered class name. | |
| static spi::ConfigurationStatus | selectAndConfigure (const File &configFileName, const LogString &className={}, const spi::LoggerRepositoryPtr &target={}, int millisecondDelay=0) |
Use the information in configFileName to configure Log4cxx. | |
A convenience class to convert property values to specific types.
|
static |
Find the value corresponding to key in props.
Then perform variable substitution on the found value.
|
static |
Gets the specified system property.
| key | The key to search for. |
| def | The default value to return. |
|
static |
Instantiate an object given a class name.
Returns defaultValue if the named class is not a registered class or the class does not inherit from superClass.
| className | The registered name of the class to construct. |
| superClass | The class from which the new object must inherit. |
| defaultValue | The value to return in case of failure |
|
static |
Instantiate an object using the value in props associated with key as a registered class name.
Returns defaultValue if the named class is not a registered class or the class does not inherit from superClass.
| key | The props entry whose value is the registered name of the class to construct. |
| superClass | The class from which the new object must inherit. |
| defaultValue | The value to return in case of failure |
|
static |
Use the information in configFileName to configure Log4cxx.
| configFileName | Holds the path of the configuration file. |
| className | The spi::Configurator subclass used to process configFileName. If empty, a registered class whose name ends with "Configurator" and whose spi::Configurator::isValid instance method returns true is used to process the configuration file. |
| target | Holds the configuration result |
| millisecondDelay | If greater than zero, the milliseconds to sleep between checking if configFileName has been modified and needs to be reloaded. |
|
static |
Perform variable substitution in string 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
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
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 "}".
| val | The string on which variable substitution is performed. |
| props | The properties from which variable substitution is performed. |
| IllegalArgumentException | if val is malformed. |
|
static |
The boolean equivalent of value if it is not empty, otherwise defaultValue.
If value is "true", then true is returned. If value is "false", then true is returned. Case of value is unimportant.
defaultValue if value is not "true" or "false", otherwise the boolean equivalent of value
|
static |
The numeric equivalent of value if it is an integer in the range 0 - 2^63, otherwise defaultValue.
A suffix "KB", "MB" or "GB" after an integer value converts the provided number respectively to kilobytes, megabytes and gigabytes. For example, the value "10KB" will be interpreted as 10240.
|
static |
The numeric equivalent of value if it is not empty, otherwise defaultValue.
value does not begin with a valid integral number otherwise the numeric equivalent of value
|
static |
The Level indicated by value if recognised otherwise defaultValue.
To be recognised, value must be one of "Trace", "Debug", "Info", "Warn", "Error", "Fatal", "Off", "All" or a custom level in which case it is of the form {levelName}#{registeredClassName}.
Case of value is unimportant.