Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::helpers::OptionConverter Class Reference

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.

Detailed Description

A convenience class to convert property values to specific types.

Member Function Documentation

◆ convertSpecialChars()

LogString log4cxx::helpers::OptionConverter::convertSpecialChars ( const LogString & s)
static

◆ findAndSubst()

LogString log4cxx::helpers::OptionConverter::findAndSubst ( const LogString & key,
const Properties & props )
static

Find the value corresponding to key in props.

Then perform variable substitution on the found value.

◆ getSystemProperty()

LogString log4cxx::helpers::OptionConverter::getSystemProperty ( const LogString & key,
const LogString & def )
static
Gets the specified system property.
Parameters
keyThe key to search for.
defThe default value to return.
Returns
the string value of the system property, or the default value if there is no property with that key.

◆ instantiateByClassName()

ObjectPtr log4cxx::helpers::OptionConverter::instantiateByClassName ( const LogString & className,
const Class & superClass,
const ObjectPtr & defaultValue )
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.

Parameters
classNameThe registered name of the class to construct.
superClassThe class from which the new object must inherit.
defaultValueThe value to return in case of failure

◆ instantiateByKey()

ObjectPtr log4cxx::helpers::OptionConverter::instantiateByKey ( const Properties & props,
const LogString & key,
const Class & superClass,
const ObjectPtr & defaultValue )
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.

Parameters
keyThe props entry whose value is the registered name of the class to construct.
superClassThe class from which the new object must inherit.
defaultValueThe value to return in case of failure

◆ selectAndConfigure()

spi::ConfigurationStatus log4cxx::helpers::OptionConverter::selectAndConfigure ( const File & configFileName,
const LogString & className = {},
const spi::LoggerRepositoryPtr & target = {},
int millisecondDelay = 0 )
static

Use the information in configFileName to configure Log4cxx.

Parameters
configFileNameHolds the path of the configuration file.
classNameThe 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.
targetHolds the configuration result
millisecondDelayIf greater than zero, the milliseconds to sleep between checking if configFileName has been modified and needs to be reloaded.

◆ substVars()

LogString log4cxx::helpers::OptionConverter::substVars ( const LogString & val,
const Properties & props )
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

auto 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

auto 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 "}".

Parameters
valThe string on which variable substitution is performed.
propsThe properties from which variable substitution is performed.
Exceptions
IllegalArgumentExceptionif val is malformed.

◆ toBoolean()

bool log4cxx::helpers::OptionConverter::toBoolean ( const LogString & value,
bool defaultValue )
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.

Returns
defaultValue if value is not "true" or "false", otherwise the boolean equivalent of value

◆ toFileSize()

size_t log4cxx::helpers::OptionConverter::toFileSize ( const LogString & value,
size_t defaultValue )
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.

◆ toInt()

int log4cxx::helpers::OptionConverter::toInt ( const LogString & value,
int defaultValue )
static

The numeric equivalent of value if it is not empty, otherwise defaultValue.

Returns
Zero if value does not begin with a valid integral number otherwise the numeric equivalent of value

◆ toLevel()

LevelPtr log4cxx::helpers::OptionConverter::toLevel ( const LogString & value,
const LevelPtr & defaultValue )
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.


The documentation for this class was generated from the following file: