Kea  2.3.4-git
isc::data::MapElement Class Reference

#include <data.h>

+ Inheritance diagram for isc::data::MapElement:

Public Member Functions

 MapElement (const Position &pos=ZERO_POSITION())
 
bool contains (const std::string &s) const override
 Checks if there is data at the given key. More...
 
bool empty () const override
 Return true if there are no elements in the list. More...
 
bool equals (const Element &other) const override
 
ConstElementPtr find (const std::string &id) const override
 Recursively finds any data at the given identifier. More...
 
bool find (const std::string &id, ConstElementPtr &t) const override
 See Element::find() More...
 
ConstElementPtr get (const std::string &s) const override
 Returns the ElementPtr at the given key. More...
 
ConstElementPtr get (int const i) const override
 Get the i-th element in the map. More...
 
bool getValue (std::map< std::string, ConstElementPtr > &t) const override
 
const std::map< std::string, ConstElementPtr > & mapValue () const override
 
void remove (const std::string &s) override
 Remove the ElementPtr at the given key. More...
 
void remove (int const i) override
 Remove the i-th element from the map. More...
 
void set (const std::string &key, ConstElementPtr value) override
 Sets the ElementPtr at the given key. More...
 
bool setValue (const std::map< std::string, ConstElementPtr > &v) override
 
size_t size () const override
 Returns number of stored elements. More...
 
void toJSON (std::ostream &ss) const override
 Converts the Element to JSON format and appends it to the given stringstream. More...
 
- Public Member Functions inherited from isc::data::Element
virtual ~Element ()
 
const PositiongetPosition () const
 Returns position where the data element's value starts in a configuration string. More...
 
int getType () const
 
void removeEmptyContainersRecursively ()
 Remove all empty maps and lists from this Element and its descendants. More...
 
std::string str () const
 Returns a string representing the Element and all its child elements; note that this is different from stringValue(), which only returns the single value of a StringElement. More...
 
std::string toWire () const
 Returns the wireformat for the Element and all its child elements. More...
 
void toWire (std::ostream &out) const
 
virtual int64_t intValue () const
 
virtual double doubleValue () const
 
virtual bool boolValue () const
 
virtual std::string stringValue () const
 
virtual const std::vector< ElementPtr > & listValue () const
 
virtual bool getValue (int64_t &t) const
 
virtual bool getValue (double &t) const
 
virtual bool getValue (bool &t) const
 
virtual bool getValue (std::string &t) const
 
virtual bool getValue (std::vector< ElementPtr > &t) const
 
virtual bool setValue (const long long int v)
 
bool setValue (const long int i)
 
bool setValue (const int i)
 
virtual bool setValue (const double v)
 
virtual bool setValue (const bool t)
 
virtual bool setValue (const std::string &v)
 
virtual bool setValue (const std::vector< ElementPtr > &v)
 
virtual ElementPtr getNonConst (const int i) const
 returns element as non-const pointer More...
 
virtual void set (const size_t i, ElementPtr element)
 Sets the ElementPtr at the given index. More...
 
virtual void add (ElementPtr element)
 Adds an ElementPtr to the list. More...
 

Additional Inherited Members

- Public Types inherited from isc::data::Element
enum  types {
  integer, real, boolean, null,
  string, list, map, any
}
 
- Static Public Member Functions inherited from isc::data::Element
static const PositionZERO_POSITION ()
 Returns Position object with line_ and pos_ set to 0, and with an empty file name. More...
 
static ElementPtr create (const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const long long int i, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const int i, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const long int i, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const uint32_t i, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const double d, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const bool b, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const std::string &s, const Position &pos=ZERO_POSITION())
 
static ElementPtr create (const char *s, const Position &pos=ZERO_POSITION())
 
static ElementPtr createList (const Position &pos=ZERO_POSITION())
 Creates an empty ListElement type ElementPtr. More...
 
static ElementPtr createMap (const Position &pos=ZERO_POSITION())
 Creates an empty MapElement type ElementPtr. More...
 
static ElementPtr fromJSON (const std::string &in, bool preproc=false)
 These functions will parse the given string (JSON) representation of a compound element. More...
 
static ElementPtr fromJSON (std::istream &in, bool preproc=false)
 Creates an Element from the given input stream containing JSON formatted data. More...
 
static ElementPtr fromJSON (std::istream &in, const std::string &file_name, bool preproc=false)
 Creates an Element from the given input stream containing JSON formatted data. More...
 
static ElementPtr fromJSON (std::istream &in, const std::string &file, int &line, int &pos)
 Creates an Element from the given input stream, where we keep track of the location in the stream for error reporting. More...
 
static ElementPtr fromJSONFile (const std::string &file_name, bool preproc=false)
 Reads contents of specified file and interprets it as JSON. More...
 
static std::string typeToName (Element::types type)
 Returns the name of the given type as a string. More...
 
static Element::types nameToType (const std::string &type_name)
 Converts the string to the corresponding type Throws a TypeError if the name is unknown. More...
 
static void preprocess (std::istream &in, std::stringstream &out)
 input text preprocessor More...
 
static ElementPtr fromWire (std::stringstream &in, int length)
 These function pparse the wireformat at the given stringstream (of the given length). More...
 
static ElementPtr fromWire (const std::string &s)
 Creates an Element from the wire format in the given string Since the wire format is JSON, this is the same as fromJSON, and could be removed. More...
 
- Protected Member Functions inherited from isc::data::Element
 Element (int t, const Position &pos=ZERO_POSITION())
 Constructor. More...
 

Detailed Description

Definition at line 701 of file data.h.

Constructor & Destructor Documentation

◆ MapElement()

isc::data::MapElement::MapElement ( const Position pos = ZERO_POSITION())
inline

Definition at line 705 of file data.h.

Member Function Documentation

◆ contains()

bool isc::data::MapElement::contains ( const std::string &  name) const
inlineoverridevirtual

Checks if there is data at the given key.

Parameters
nameThe key of the Element checked for existence
Returns
true if there is data at the key, false if not.

Reimplemented from isc::data::Element.

Definition at line 753 of file data.h.

◆ empty()

bool isc::data::MapElement::empty ( ) const
inlineoverridevirtual

Return true if there are no elements in the list.

Reimplemented from isc::data::Element.

Definition at line 780 of file data.h.

References isc::data::isNull(), isc::data::merge(), and isc::data::removeIdentical().

+ Here is the call graph for this function:

◆ equals()

bool isc::data::MapElement::equals ( const Element other) const
overridevirtual
Returns
true if the other ElementPtr has the same type and value

Implements isc::data::Element.

Definition at line 1066 of file data.cc.

References isc::data::Element::contains(), isc::data::Element::get(), isc::data::Element::getType(), and isc::data::Element::size().

+ Here is the call graph for this function:

◆ find() [1/2]

ConstElementPtr isc::data::MapElement::find ( const std::string &  identifier) const
overridevirtual

Recursively finds any data at the given identifier.

The identifier is a /-separated list of names of nested maps, with the last name being the leaf that is returned.

For instance, if you have a MapElement that contains another MapElement at the key "foo", and that second MapElement contains Another Element at key "bar", the identifier for that last element from the first is "foo/bar".

Parameters
identifierThe identifier of the element to find
Returns
The ElementPtr at the given identifier. Returns a null ElementPtr if it is not found, which can be checked with Element::is_null(ElementPtr e).

Reimplemented from isc::data::Element.

Definition at line 920 of file data.cc.

◆ find() [2/2]

bool isc::data::MapElement::find ( const std::string &  identifier,
ConstElementPtr t 
) const
overridevirtual

See Element::find()

Parameters
identifierThe identifier of the element to find
tReference to store the resulting ElementPtr, if found.
Returns
true if the element was found, false if not.

Reimplemented from isc::data::Element.

Definition at line 969 of file data.cc.

◆ get() [1/2]

ConstElementPtr isc::data::MapElement::get ( const std::string &  name) const
inlineoverridevirtual

Returns the ElementPtr at the given key.

Parameters
nameThe key of the Element to return
Returns
The ElementPtr at the given key, or null if not present

Reimplemented from isc::data::Element.

Definition at line 722 of file data.h.

◆ get() [2/2]

ConstElementPtr isc::data::MapElement::get ( int const  i) const
inlineoverridevirtual

Get the i-th element in the map.

Useful when required to iterate with an index.

Parameters
ithe position of the element you want to return
Returns
the element at position i

Reimplemented from isc::data::Element.

Definition at line 733 of file data.h.

References isc::data::Element::remove(), and isc::data::Element::set().

+ Here is the call graph for this function:

◆ getValue()

bool isc::data::MapElement::getValue ( std::map< std::string, ConstElementPtr > &  t) const
inlineoverridevirtual

Reimplemented from isc::data::Element.

Definition at line 712 of file data.h.

References isc::data::Element::setValue().

+ Here is the call graph for this function:

◆ mapValue()

const std::map<std::string, ConstElementPtr>& isc::data::MapElement::mapValue ( ) const
inlineoverridevirtual

Reimplemented from isc::data::Element.

Definition at line 708 of file data.h.

References isc::data::Element::getValue().

+ Here is the call graph for this function:

◆ remove() [1/2]

void isc::data::MapElement::remove ( const std::string &  name)
inlineoverridevirtual

Remove the ElementPtr at the given key.

Parameters
nameThe key of the Element to remove

Reimplemented from isc::data::Element.

Definition at line 742 of file data.h.

◆ remove() [2/2]

void isc::data::MapElement::remove ( int const  i)
inlineoverridevirtual

Remove the i-th element from the map.

Parameters
ithe position of the element you want to remove

Reimplemented from isc::data::Element.

Definition at line 747 of file data.h.

◆ set()

void isc::data::MapElement::set ( const std::string &  name,
ConstElementPtr  element 
)
overridevirtual

Sets the ElementPtr at the given key.

Parameters
nameThe key of the Element to set
elementThe ElementPtr to set at the given key.

Reimplemented from isc::data::Element.

Definition at line 964 of file data.cc.

◆ setValue()

bool isc::data::MapElement::setValue ( const std::map< std::string, ConstElementPtr > &  v)
inlineoverridevirtual

Reimplemented from isc::data::Element.

Definition at line 717 of file data.h.

References isc::data::Element::get().

+ Here is the call graph for this function:

◆ size()

size_t isc::data::MapElement::size ( ) const
inlineoverridevirtual

Returns number of stored elements.

Returns
number of elements.

Reimplemented from isc::data::Element.

Definition at line 774 of file data.h.

◆ toJSON()

void isc::data::MapElement::toJSON ( std::ostream &  ss) const
overridevirtual

Converts the Element to JSON format and appends it to the given stringstream.

Implements isc::data::Element.

Definition at line 897 of file data.cc.


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