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

Inheritance diagram for Avro.NamedSchema:

Collaboration diagram for Avro.NamedSchema:

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)

internal override void	WriteJson (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes named schema in JSON format More...

internal override void	WriteJsonFields (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes named schema in JSON format More...

Protected Member Functions inherited from Avro.Schema
	Schema (Type type, PropertyMap props)
	Constructor for schema class More...

virtual internal void	WriteJsonFields (JsonTextWriter writer, SchemaNames names, string encspace)
	Default implementation for writing schema properties in JSON format More...

virtual internal void	WriteJson (JsonTextWriter writer, SchemaNames names, string encspace)
	Writes schema object in JSON format 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< SchemaName >	GetAliases (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. More...

Additional Inherited Members
Public Types inherited from Avro.Schema
enum	Type { Type.Null, Type.Boolean, Type.Int, Type.Long, Type.Float, Type.Double, Type.Bytes, Type.String, Type.Record, Type.Enumeration, Type.Array, Type.Map, Type.Union, Type.Fixed, Type.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

Definition at line 29 of file NamedSchema.cs.

Constructor & Destructor Documentation

◆ NamedSchema()

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

inlineprotected

Constructor for named schema class

Parameters

type	schema type
name	name
names	list of named schemas already read

Definition at line 99 of file NamedSchema.cs.

Member Function Documentation

◆ GetAliases()

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

inlinestaticprotected

Parses the 'aliases' property from the given JSON token

Parameters

jtok	JSON object to read
space	namespace of the name this alias is for
encspace	enclosing 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.

Definition at line 130 of file NamedSchema.cs.

◆ GetName()

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

jtok	JSON object to read
encspace	enclosing namespace

Returns: new SchemaName object

Definition at line 116 of file NamedSchema.cs.

◆ InAliases()

bool Avro.NamedSchema.InAliases ( SchemaName name )

inlineprotected

Definition at line 150 of file NamedSchema.cs.

◆ WriteJson()

internal override void Avro.NamedSchema.WriteJson	(	Newtonsoft.Json.JsonTextWriter	writer,
		SchemaNames	names,
		string	encspace
	)

inlineprotected

Writes named schema in JSON format

Parameters

writer	JSON writer
names	list of named schemas already written
encspace	enclosing namespace of the named schema

Definition at line 166 of file NamedSchema.cs.

◆ WriteJsonFields()

internal override void Avro.NamedSchema.WriteJsonFields	(	Newtonsoft.Json.JsonTextWriter	writer,
		SchemaNames	names,
		string	encspace
	)

inlineprotected

Writes named schema in JSON format

Parameters

writer	JSON writer
names	list of named schemas already written
encspace	enclosing namespace of the named schema

Definition at line 190 of file NamedSchema.cs.

Property Documentation

◆ Fullname

string Avro.NamedSchema.Fullname

get

Namespace.Name of the schema

Definition at line 56 of file NamedSchema.cs.

◆ Name

override string Avro.NamedSchema.Name

get

Name of the schema

Definition at line 40 of file NamedSchema.cs.

◆ Namespace

string Avro.NamedSchema.Namespace

get

Namespace of the schema

Definition at line 48 of file NamedSchema.cs.

◆ SchemaName

SchemaName Avro.NamedSchema.SchemaName

get

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

Definition at line 34 of file NamedSchema.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Avro/src/apache/main/Schema/NamedSchema.cs

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NamedSchema()

Member Function Documentation

◆ GetAliases()

◆ GetName()

◆ InAliases()

◆ WriteJson()

◆ WriteJsonFields()

Property Documentation

◆ Fullname

◆ Name

◆ Namespace

◆ SchemaName