Avro C#
 All Classes Namespaces Functions Variables Enumerations Properties
Protected Member Functions | Static Protected Member Functions | Properties | List of all members
Avro.NamedSchema Class Reference

Base class for all named schemas: fixed, enum, record More...

Inheritance diagram for Avro.NamedSchema:
Avro.Schema Avro.EnumSchema Avro.FixedSchema Avro.RecordSchema

Protected Member Functions

 NamedSchema (Type type, SchemaName name, IList< SchemaName > aliases, PropertyMap props, SchemaNames names)
 Constructor for named schema class More...
 
bool InAliases (SchemaName name)
 
- Protected Member Functions inherited from Avro.Schema
 Schema (Type type, PropertyMap props)
 Constructor for schema class More...
 

Static Protected Member Functions

static SchemaName GetName (JToken jtok, string encspace)
 Parses the name and namespace from the given JSON schema object then creates SchemaName object including the given enclosing namespace More...
 
static IList< SchemaNameGetAliases (JToken jtok, string space, string encspace)
 Parses the 'aliases' property from the given JSON token More...
 
- Static Protected Member Functions inherited from Avro.Schema
static bool areEqual (object o1, object o2)
 Compares two objects, null is equal to null More...
 
static int getHashCode (object obj)
 Hash code helper function More...
 

Properties

SchemaName SchemaName [get]
 Name of the schema, contains name, namespace and enclosing namespace More...
 
override string Name [get]
 Name of the schema More...
 
string Namespace [get]
 Namespace of the schema More...
 
string Fullname [get]
 Namespace.Name of the schema More...
 
- Properties inherited from Avro.Schema
Type Tag [get]
 Schema type property More...
 
abstract string Name [get]
 The name of this schema. If this is a named schema such as an enum, it returns the fully qualified name for the schema. For other schemas, it returns the type of the schema. More...
 

Additional Inherited Members

- Public Types inherited from Avro.Schema
enum  Type {
  Null, Boolean, Int, Long,
  Float, Double, Bytes, String,
  Record, Enumeration, Array, Map,
  Union, Fixed, Error
}
 Enum for schema types More...
 
- Public Member Functions inherited from Avro.Schema
override string ToString ()
 Returns the canonical JSON representation of this schema. More...
 
string GetProperty (string key)
 Returns the schema's custom property value given the property name More...
 
override int GetHashCode ()
 Hash code function More...
 
virtual bool CanRead (Schema writerSchema)
 Returns true if and only if data written using writerSchema can be read using the current schema according to the Avro resolution rules. More...
 
- Static Public Member Functions inherited from Avro.Schema
static Schema Parse (string json)
 Parses a given JSON string to create a new schema object More...
 
static string GetTypeString (Type type)
 Returns symbol name for the given schema type More...
 

Detailed Description

Base class for all named schemas: fixed, enum, record

Constructor & Destructor Documentation

Avro.NamedSchema.NamedSchema ( Type  type,
SchemaName  name,
IList< SchemaName aliases,
PropertyMap  props,
SchemaNames  names 
)
inlineprotected

Constructor for named schema class

Parameters
typeschema type
namename
nameslist of named schemas already read

Member Function Documentation

static IList<SchemaName> Avro.NamedSchema.GetAliases ( JToken  jtok,
string  space,
string  encspace 
)
inlinestaticprotected

Parses the 'aliases' property from the given JSON token

Parameters
jtokJSON object to read
spacenamespace of the name this alias is for
encspaceenclosing namespace of the name this alias is for
Returns
List of SchemaName that represents the list of alias. If no 'aliases' specified, then it returns null.
static SchemaName Avro.NamedSchema.GetName ( JToken  jtok,
string  encspace 
)
inlinestaticprotected

Parses the name and namespace from the given JSON schema object then creates SchemaName object including the given enclosing namespace

Parameters
jtokJSON object to read
encspaceenclosing namespace
Returns
new SchemaName object

Property Documentation

string Avro.NamedSchema.Fullname
get

Namespace.Name of the schema

override string Avro.NamedSchema.Name
get

Name of the schema

string Avro.NamedSchema.Namespace
get

Namespace of the schema

SchemaName Avro.NamedSchema.SchemaName
get

Name of the schema, contains name, namespace and enclosing namespace


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