bes  Updated for version 3.20.5
GenericSchemaDocument< ValueT, Allocator > Class Template Reference

JSON schema document. More...

#include <schema.h>

Collaboration diagram for GenericSchemaDocument< ValueT, Allocator >:
Collaboration graph

Public Types

typedef Allocator AllocatorType
 
typedef EncodingType::Ch Ch
 
typedef ValueType::EncodingType EncodingType
 
typedef IGenericRemoteSchemaDocumentProvider< GenericSchemaDocumentIRemoteSchemaDocumentProviderType
 
typedef GenericPointer< ValueType, AllocatorPointerType
 
typedef internal::Schema< GenericSchemaDocumentSchemaType
 
typedef ValueT ValueType
 

Public Member Functions

 GenericSchemaDocument (const ValueType &document, IRemoteSchemaDocumentProviderType *remoteProvider=0, Allocator *allocator=0)
 Constructor. More...
 
const SchemaTypeGetRoot () const
 Get the root schema. More...
 
 ~GenericSchemaDocument ()
 Destructor. More...
 

Friends

template<typename , typename , typename >
class GenericSchemaValidator
 
class internal::Schema< GenericSchemaDocument >
 

Detailed Description

template<typename ValueT, typename Allocator = CrtAllocator>
class GenericSchemaDocument< ValueT, Allocator >

JSON schema document.

A JSON schema document is a compiled version of a JSON schema. It is basically a tree of internal::Schema.

Note
This is an immutable class (i.e. its instance cannot be modified after construction).
Template Parameters
ValueTType of JSON value (e.g. Value ), which also determine the encoding.
AllocatorAllocator type for allocating memory of this document.

Definition at line 136 of file fwd.h.

Constructor & Destructor Documentation

◆ GenericSchemaDocument()

template<typename ValueT , typename Allocator = CrtAllocator>
GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument ( const ValueType &  document,
IRemoteSchemaDocumentProviderType remoteProvider = 0,
Allocator allocator = 0 
)
inlineexplicit

Constructor.

Compile a JSON document into schema document.

Parameters
documentA JSON document as source.
remoteProviderAn optional remote schema document provider for resolving remote reference. Can be null.
allocatorAn optional allocator instance for allocating memory. Can be null.

Definition at line 1341 of file schema.h.

◆ ~GenericSchemaDocument()

template<typename ValueT , typename Allocator = CrtAllocator>
GenericSchemaDocument< ValueT, Allocator >::~GenericSchemaDocument ( )
inline

Destructor.

Definition at line 1393 of file schema.h.

Member Function Documentation

◆ GetRoot()

template<typename ValueT , typename Allocator = CrtAllocator>
const SchemaType& GenericSchemaDocument< ValueT, Allocator >::GetRoot ( ) const
inline

Get the root schema.

Definition at line 1401 of file schema.h.


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