blob: e3344884d45cf8271c861094a9f222111c5d0d1d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects
* for all of the code used other than as permitted herein. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you do not
* wish to do so, delete this exception statement from your version. If you
* delete this exception statement from all source files in the program,
* then also delete it in the license file.
*/
#pragma once
#include <string>
#include "mongo/db/jsobj.h"
namespace mongo {
/**
* "Types" are the interface to a known data structure that will be serialized to and
* deserialized from BSON.
*/
class BSONSerializable {
public:
virtual ~BSONSerializable() {}
/**
* Returns true if all the mandatory fields are present and have valid
* representations. Otherwise returns false and fills in the optional 'errMsg' string.
*/
virtual bool isValid( std::string* errMsg ) const = 0;
/** Returns the BSON representation of the entry. */
virtual BSONObj toBSON() const = 0;
/**
* Clears and populates the internal state using the 'source' BSON object if the
* latter contains valid values. Otherwise sets errMsg and returns false.
*/
virtual bool parseBSON( const BSONObj& source, std::string* errMsg ) = 0;
/** Clears the internal state. */
virtual void clear() = 0;
/** Returns a std::string representation of the current internal state. */
virtual std::string toString() const = 0;
};
} // namespace mongo
|
