log4cplus  1.1.0
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes
log4cplus::helpers::Properties Class Reference

#include <property.h>

List of all members.

Public Types

enum  PFlags { fEncodingShift = 3, fEncodingMask = 0x3, fUnspecEncoding = (0 << fEncodingShift) }

Public Member Functions

 Properties ()
 Properties (log4cplus::tistream &input)
 Properties (const log4cplus::tstring &inputFile, unsigned flags=0)
virtual ~Properties ()
bool exists (const log4cplus::tstring &key) const
 Tests to see if key can be found in this map.
bool exists (tchar const *key) const
std::size_t size () const
 Returns the number of entries in this map.
log4cplus::tstring const & getProperty (const log4cplus::tstring &key) const
 Searches for the property with the specified key in this property list.
log4cplus::tstring const & getProperty (tchar const *key) const
log4cplus::tstring getProperty (const log4cplus::tstring &key, const log4cplus::tstring &defaultVal) const
 Searches for the property with the specified key in this property list.
std::vector< log4cplus::tstringpropertyNames () const
 Returns all the keys in this property list.
void setProperty (const log4cplus::tstring &key, const log4cplus::tstring &value)
 Inserts value into this map indexed by key.
bool removeProperty (const log4cplus::tstring &key)
 Removed the property index by key from this map.
Properties getPropertySubset (const log4cplus::tstring &prefix) const
 Returns a subset of the "properties" whose keys start with "prefix".
bool getInt (int &val, log4cplus::tstring const &key) const
bool getUInt (unsigned &val, log4cplus::tstring const &key) const
bool getLong (long &val, log4cplus::tstring const &key) const
bool getULong (unsigned long &val, log4cplus::tstring const &key) const
bool getBool (bool &val, log4cplus::tstring const &key) const

Static Public Attributes

static const tchar PROPERTIES_COMMENT_CHAR

Protected Types

typedef std::map
< log4cplus::tstring,
log4cplus::tstring
StringMap

Protected Member Functions

void init (log4cplus::tistream &input)

Protected Attributes

StringMap data
unsigned flags

Detailed Description

See also:
log4cplus::PropertyConfigurator

Definition at line 43 of file property.h.


Member Typedef Documentation

Definition at line 138 of file property.h.


Member Enumeration Documentation

Enumerator:
fEncodingShift 
fEncodingMask 
fUnspecEncoding 

Definition at line 45 of file property.h.


Constructor & Destructor Documentation

log4cplus::helpers::Properties::Properties ( const log4cplus::tstring inputFile,
unsigned  flags = 0 
) [explicit]

Member Function Documentation

Tests to see if key can be found in this map.

Referenced by log4cplus::DeviceAppender< Device >::DeviceAppender().

bool log4cplus::helpers::Properties::exists ( tchar const *  key) const
bool log4cplus::helpers::Properties::getBool ( bool &  val,
log4cplus::tstring const &  key 
) const
bool log4cplus::helpers::Properties::getInt ( int &  val,
log4cplus::tstring const &  key 
) const
bool log4cplus::helpers::Properties::getLong ( long &  val,
log4cplus::tstring const &  key 
) const

Searches for the property with the specified key in this property list.

If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Searches for the property with the specified key in this property list.

If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Returns a subset of the "properties" whose keys start with "prefix".

The returned "properties" have "prefix" trimmed from their keys.

bool log4cplus::helpers::Properties::getUInt ( unsigned &  val,
log4cplus::tstring const &  key 
) const
bool log4cplus::helpers::Properties::getULong ( unsigned long &  val,
log4cplus::tstring const &  key 
) const

Returns all the keys in this property list.

Removed the property index by key from this map.

Inserts value into this map indexed by key.

std::size_t log4cplus::helpers::Properties::size ( ) const [inline]

Returns the number of entries in this map.

Definition at line 84 of file property.h.


Member Data Documentation

Definition at line 144 of file property.h.

Definition at line 145 of file property.h.

Definition at line 72 of file property.h.


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