Class for union schemas More...

Inheritance diagram for Avro.UnionSchema:

Collaboration diagram for Avro.UnionSchema:

Public Member Functions
int	MatchingBranch (Schema s)
	Returns the index of a branch that can read the data written by the given schema s. More...

override bool	CanRead (Schema writerSchema)
	Checks if this schema can read data written by the given schema. More...

override bool	Equals (object obj)
	Compares two union schema objects More...

override int	GetHashCode ()
	Hash code function 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	WriteJson (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes union schema in JSON format More...

Protected Member Functions inherited from Avro.UnnamedSchema
	UnnamedSchema (Type type, PropertyMap props)

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< Schema >	Schemas `[get]`
	List of schemas in the union More...

int	Count `[get]`
	Count of schemas in the union More...

Schema	this[int index] `[get]`
	Returns the schema at the given branch. More...

Properties inherited from Avro.UnnamedSchema
override string	Name `[get]`

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

Definition at line 29 of file UnionSchema.cs.

Member Function Documentation

◆ CanRead()

override bool Avro.UnionSchema.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 127 of file UnionSchema.cs.

◆ Equals()

override bool Avro.UnionSchema.Equals ( object obj )

inline

Compares two union schema objects

Parameters

obj	union schema object to compare against this schema

Returns: true if objects are equal, false otherwise

Definition at line 137 of file UnionSchema.cs.

◆ GetHashCode()

override int Avro.UnionSchema.GetHashCode ( )

inline

Hash code function

Returns

Definition at line 156 of file UnionSchema.cs.

◆ MatchingBranch()

int Avro.UnionSchema.MatchingBranch ( Schema s )

inline

Returns the index of a branch that can read the data written by the given schema s.

Parameters

s	The schema to match the branches against.

Returns: The index of the matching branch. If non matches a -1 is returned.

Definition at line 113 of file UnionSchema.cs.

◆ WriteJson()

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

inlineprotected

Writes union schema in JSON format

Parameters

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

Definition at line 100 of file UnionSchema.cs.

Property Documentation

◆ Count

int Avro.UnionSchema.Count

get

Count of schemas in the union

Definition at line 39 of file UnionSchema.cs.

◆ Schemas

IList<Schema> Avro.UnionSchema.Schemas

get

List of schemas in the union

Definition at line 34 of file UnionSchema.cs.

◆ this[int index]

Schema Avro.UnionSchema.this[int index]

get

Returns the schema at the given branch.

Parameters

index Index to the branch, starting with 0.

Returns: The branch corresponding to the given index.

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanRead()

◆ Equals()

◆ GetHashCode()

◆ MatchingBranch()

◆ WriteJson()

Property Documentation

◆ Count

◆ Schemas

◆ this[int index]