Class for enum type schemas More...

Inheritance diagram for Avro.EnumSchema:

Collaboration diagram for Avro.EnumSchema:

Public Member Functions
int	Ordinal (string symbol)
	Returns the position of the given symbol within this enum. More...

bool	Contains (string symbol)
	Checks if given symbol is in the list of enum symbols More...

IEnumerator< string >	GetEnumerator ()
	Returns an enumerator that enumerates the symbols in this enum schema in the order of their definition. More...

override bool	Equals (object obj)
	Checks equality of two enum schema More...

override int	GetHashCode ()
	Hashcode function More...

override bool	CanRead (Schema writerSchema)
	Checks if this schema can read data written by the given schema. 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...

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

Protected Member Functions inherited from Avro.NamedSchema
	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...

Properties
IList< string >	Symbols `[get]`
	List of strings representing the enum symbols More...

int	Count `[get]`
	Count of enum symbols More...

string	this[int index] `[get]`
	Returns the enum symbol of the given index to the list More...

Properties inherited from Avro.NamedSchema
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...

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...

Static Protected Member Functions inherited from Avro.NamedSchema
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...

Detailed Description

Class for enum type schemas

Definition at line 28 of file EnumSchema.cs.

Member Function Documentation

◆ CanRead()

override bool Avro.EnumSchema.CanRead ( Schema writerSchema )

inlinevirtual

Checks if this schema can read data written by the given schema.

Used for decoding data.

Parameters

writerSchema writer schema

Returns: true if this and writer schema are compatible based on the AVRO specification, false otherwise

Reimplemented from Avro.Schema.

Definition at line 192 of file EnumSchema.cs.

◆ Contains()

bool Avro.EnumSchema.Contains ( string symbol )

inline

Checks if given symbol is in the list of enum symbols

Parameters

symbol symbol to check

Returns: true if symbol exist, false otherwise

Definition at line 142 of file EnumSchema.cs.

◆ Equals()

override bool Avro.EnumSchema.Equals ( object obj )

inline

Checks equality of two enum schema

Parameters

obj

Returns

Definition at line 161 of file EnumSchema.cs.

◆ GetEnumerator()

IEnumerator<string> Avro.EnumSchema.GetEnumerator ( )

inline

Returns an enumerator that enumerates the symbols in this enum schema in the order of their definition.

Returns: Enumeration over the symbols of this enum schema

Definition at line 151 of file EnumSchema.cs.

◆ GetHashCode()

override int Avro.EnumSchema.GetHashCode ( )

inline

Hashcode function

Returns

Definition at line 180 of file EnumSchema.cs.

◆ Ordinal()

int Avro.EnumSchema.Ordinal ( string symbol )

inline

Returns the position of the given symbol within this enum.

Throws AvroException if the symbol is not found in this enum.

Parameters

symbol name of the symbol to find

Returns: position of the given symbol in this enum schema

Definition at line 116 of file EnumSchema.cs.

◆ WriteJsonFields()

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

inlineprotected

Writes enum schema in JSON format

Parameters

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

Definition at line 99 of file EnumSchema.cs.

Property Documentation

◆ Count

int Avro.EnumSchema.Count

get

Count of enum symbols

Definition at line 43 of file EnumSchema.cs.

◆ Symbols

IList<string> Avro.EnumSchema.Symbols

get

List of strings representing the enum symbols

Definition at line 33 of file EnumSchema.cs.

◆ this[int index]

string Avro.EnumSchema.this[int index]

get

Returns the enum symbol of the given index to the list

Parameters

index symbol index

Returns: symbol name

Definition at line 129 of file EnumSchema.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/EnumSchema.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanRead()

◆ Contains()

◆ Equals()

◆ GetEnumerator()

◆ GetHashCode()

◆ Ordinal()

◆ WriteJsonFields()

Property Documentation

◆ Count

◆ Symbols

◆ this[int index]