Avro.MapSchema Class Reference

Class for map schemas More...

Inheritance diagram for Avro.MapSchema:

Collaboration diagram for Avro.MapSchema:

Public Member Functions
override bool	CanRead (Schema writerSchema)
	Checks if this schema can read data written by the given schema. More...
override bool	Equals (object obj)
	Compares equality of two map schemas More...
override int	GetHashCode ()
	Hashcode 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...

Static Public Member Functions
static MapSchema	CreateMap (Schema type)
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...

Protected Member Functions
internal override void	WriteJsonFields (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes map 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
Schema	ValueSchema [get, set]
	Schema for map values type 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 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 map schemas

Definition at line 28 of file MapSchema.cs.

Member Function Documentation

CanRead()

override bool Avro.MapSchema.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 82 of file MapSchema.cs.

CreateMap()

static MapSchema Avro.MapSchema.CreateMap ( Schema  type )

inlinestatic

Definition at line 35 of file MapSchema.cs.

Equals()

override bool Avro.MapSchema.Equals ( object  obj )

inline

Compares equality of two map schemas

Parameters

obj	map schema to compare against this schema

Returns

true if two schemas are equal, false otherwise

Definition at line 95 of file MapSchema.cs.

GetHashCode()

override int Avro.MapSchema.GetHashCode ( )

inline

Hashcode function

Returns

Definition at line 112 of file MapSchema.cs.

WriteJsonFields()

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

inlineprotected

Writes map schema in JSON format

Parameters

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

Definition at line 71 of file MapSchema.cs.

Property Documentation

ValueSchema

Schema Avro.MapSchema.ValueSchema

getset

Schema for map values type

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