aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/apache/avro/api/ValidSchema.hh
blob: eeff4ef6107ac2261cf72bdbc2e23cec9a2e1874 (plain) (blame)
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
/* 
 * Licensed to the Apache Software Foundation (ASF) under one 
 * or more contributor license agreements.  See the NOTICE file 
 * distributed with this work for additional information 
 * regarding copyright ownership.  The ASF licenses this file 
 * to you under the Apache License, Version 2.0 (the 
 * "License"); you may not use this file except in compliance 
 * with the License.  You may obtain a copy of the License at 
 * 
 *     https://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 
#ifndef avro_ValidSchema_hh__ 
#define avro_ValidSchema_hh__ 
 
#include "Config.hh" 
#include "Node.hh" 
 
namespace avro { 
 
class AVRO_DECL Schema; 
 
/// A ValidSchema is basically a non-mutable Schema that has passed some 
/// minimum of sanity checks.  Once validated, any Schema that is part of 
/// this ValidSchema is considered locked, and cannot be modified (an attempt 
/// to modify a locked Schema will throw).  Also, as it is validated, any 
/// recursive duplications of schemas are replaced with symbolic links to the 
/// original. 
/// 
/// Once a Schema is converted to a valid schema it can be used in validating 
/// parsers/serializers, converted to a json schema, etc. 
/// 
 
class AVRO_DECL ValidSchema { 
public: 
    explicit ValidSchema(const NodePtr &root); 
    explicit ValidSchema(const Schema &schema); 
    ValidSchema(); 
 
    void setSchema(const Schema &schema); 
 
    const NodePtr &root() const { 
        return root_; 
    } 
 
    void toJson(std::ostream &os) const; 
    std::string toJson(bool prettyPrint = true) const; 
 
    void toFlatList(std::ostream &os) const; 
 
  protected: 
    NodePtr root_; 
 
  private: 
    static std::string compactSchema(const std::string &schema); 
}; 
 
} // namespace avro 
 
#endif