Avro C++

CustomAttributes.hh
1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 #ifndef avro_CustomAttributes_hh__
20 #define avro_CustomAttributes_hh__
21
22 #include <boost/optional.hpp>
23 #include <iostream>
24 #include <map>
25 #include <string>
26 #include "Config.hh"
27
28 namespace avro {
29
30 // CustomAttributes class stores avro custom attributes.
31 // Each attribute is represented by a unique name and value.
32 // User is supposed to create CustomAttributes object and then add it to Schema.
33 class AVRO_DECL CustomAttributes {
34 public:
35 // Retrieves the custom attribute json entity for that attributeName, returns an
36 // null if the attribute doesn't exist.
37 boost::optional<std::string> getAttribute(const std::string &name) const;
38
39 // Adds a custom attribute. If the attribute already exists, throw an exception.
40 void addAttribute(const std::string &name, const std::string &value);
41
42 // Provides a way to iterate over the custom attributes or check attribute size.
43 const std::map<std::string, std::string> &attributes() const {
44 return attributes_;
45 }
46
47 // Prints the attribute value for the specific attribute.
48 void printJson(std::ostream& os, const std::string &name) const;
49
50 private:
51 std::map<std::string, std::string> attributes_;
52 };
53
54 } // namespace avro
55
56 #endif
avro::CustomAttributes
Definition: CustomAttributes.hh:33
avro
A bunch of templates and specializations for encoding and decoding specific types.
Definition: AvroParse.hh:30