![]() |
Kea 2.7.7
|
#include <data.h>
Public Member Functions | |
ListElement (const Position &pos=ZERO_POSITION()) | |
void | add (ElementPtr e) |
Adds an ElementPtr to the list. | |
bool | empty () const |
Return true if there are no elements in the list. | |
bool | equals (const Element &other) const |
virtual ConstElementPtr | get (const std::string &name) const |
Returns the ElementPtr at the given key. | |
ConstElementPtr | get (int i) const |
Returns the ElementPtr at the given index. | |
ElementPtr | getNonConst (int i) const |
returns element as non-const pointer | |
virtual bool | getValue (bool &t) const |
virtual bool | getValue (double &t) const |
virtual bool | getValue (int64_t &t) const |
virtual bool | getValue (std::map< std::string, ConstElementPtr > &t) const |
virtual bool | getValue (std::string &t) const |
bool | getValue (std::vector< ElementPtr > &t) const |
const std::vector< ElementPtr > & | listValue () const |
virtual void | remove (const std::string &name) |
Remove the ElementPtr at the given key. | |
void | remove (int i) |
Removes the element at the given position. | |
virtual void | set (const std::string &name, ConstElementPtr element) |
Sets the ElementPtr at the given key. | |
void | set (size_t i, ElementPtr e) |
Sets the ElementPtr at the given index. | |
virtual bool | setValue (const bool t) |
virtual bool | setValue (const double v) |
bool | setValue (const int i) |
virtual bool | setValue (const isc::util::int128_t &v) |
bool | setValue (const long int i) |
virtual bool | setValue (const long long int v) |
virtual bool | setValue (const std::map< std::string, ConstElementPtr > &v) |
virtual bool | setValue (const std::string &v) |
bool | setValue (const std::vector< ElementPtr > &v) |
size_t | size () const |
Returns the number of elements in the list. | |
void | sort (std::string const &index=std::string()) |
Sorts the elements inside the list. | |
void | toJSON (std::ostream &ss) const |
Converts the Element to JSON format and appends it to the given stringstream. | |
![]() | |
virtual | ~Element () |
const Position & | getPosition () const |
Returns position where the data element's value starts in a configuration string. | |
types | getType () const |
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. | |
std::string | toWire () const |
Returns the wireformat for the Element and all its child elements. | |
void | toWire (std::ostream &out) const |
virtual int64_t | intValue () const |
virtual isc::util::int128_t | bigIntValue () const |
virtual double | doubleValue () const |
virtual bool | boolValue () const |
virtual std::string | stringValue () const |
virtual const std::map< std::string, ConstElementPtr > & | mapValue () const |
bool | setValue (const long int i) |
bool | setValue (const int i) |
virtual bool | contains (const std::string &name) const |
Checks if there is data at the given key. | |
virtual ConstElementPtr | find (const std::string &identifier) const |
Recursively finds any data at the given identifier. | |
virtual bool | find (const std::string &identifier, ConstElementPtr &t) const |
See Element::find() | |
void | removeEmptyContainersRecursively () |
Remove all empty maps and lists from this Element and its descendants. | |
Additional Inherited Members | |
![]() | |
enum | types : int { integer = 0 , real = 1 , boolean = 2 , null = 3 , string = 4 , bigint = 5 , list = 6 , map = 7 , any = 8 } |
The types that an Element can hold. More... | |
![]() | |
static const Position & | ZERO_POSITION () |
Returns Position object with line_ and pos_ set to 0, and with an empty file name. | |
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 isc::util::int128_t &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. | |
static ElementPtr | createMap (const Position &pos=ZERO_POSITION()) |
Creates an empty MapElement type ElementPtr. | |
static ElementPtr | fromJSON (const std::string &in, bool preproc=false) |
These functions will parse the given string (JSON) representation of a compound element. | |
static ElementPtr | fromJSON (std::istream &in, bool preproc=false) |
Creates an Element from the given input stream containing JSON formatted data. | |
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. | |
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. | |
static ElementPtr | fromJSONFile (const std::string &file_name, bool preproc=false) |
Reads contents of specified file and interprets it as JSON. | |
static std::string | typeToName (Element::types type) |
Returns the name of the given type as a string. | |
static Element::types | nameToType (const std::string &type_name) |
Converts the string to the corresponding type Throws a TypeError if the name is unknown. | |
static void | preprocess (std::istream &in, std::stringstream &out) |
input text preprocessor | |
static ElementPtr | fromWire (std::stringstream &in, int length) |
These function pparse the wireformat at the given stringstream (of the given length). | |
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. | |
![]() | |
Element (types t, const Position &pos=ZERO_POSITION()) | |
Constructor. | |
|
inline |
|
inlinevirtual |
Adds an ElementPtr to the list.
element | The ElementPtr to add |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Return true if there are no elements in the list.
Reimplemented from isc::data::Element.
|
virtual |
Implements isc::data::Element.
Definition at line 1072 of file data.cc.
References isc::data::Element::equals(), isc::data::Element::get(), isc::data::Element::getType(), isc::data::Element::list, and isc::data::Element::size().
|
virtual |
Returns the ElementPtr at the given key.
name | The key of the Element to return |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Returns the ElementPtr at the given index.
If the index is out of bounds, this function throws an std::out_of_range exception.
i | The position of the ElementPtr to return |
Reimplemented from isc::data::Element.
|
inlinevirtual |
returns element as non-const pointer
i | The position of the ElementPtr to retrieve |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Reimplemented from isc::data::Element.
|
virtual |
Remove the ElementPtr at the given key.
name | The key of the Element to remove |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Removes the element at the given position.
If the index is out of nothing happens.
i | The index of the element to remove. |
Reimplemented from isc::data::Element.
|
virtual |
Sets the ElementPtr at the given key.
name | The key of the Element to set |
element | The ElementPtr to set at the given key. |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Sets the ElementPtr at the given index.
If the index is out of bounds, this function throws an std::out_of_range exception.
i | The position of the ElementPtr to set |
element | The ElementPtr to set at the position |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
virtual |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Reimplemented from isc::data::Element.
|
inlinevirtual |
Returns the number of elements in the list.
Reimplemented from isc::data::Element.
void isc::data::ListElement::sort | ( | std::string const & | index = std::string() | ) |
Sorts the elements inside the list.
The list must contain elements of the same type. Call with the key by which you want to sort when the list contains maps. Nested lists are not supported. Call without a parameter when sorting any other type.
index | the key by which you want to sort when the list contains maps |
Definition at line 1090 of file data.cc.
References isc_throw.
|
virtual |
Converts the Element to JSON format and appends it to the given stringstream.
Implements isc::data::Element.
Definition at line 922 of file data.cc.
References isc::data::Element::listValue().