Class for enum type schemas. More...

Inheritance diagram for Avro.EnumSchema:

Public Member Functions
int	Ordinal (string symbol)
	Returns the position of the given symbol within this enum. Throws AvroException if the symbol is not found in this enum.

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

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

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

override int	GetHashCode ()
	Hashcode function.

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

Public Member Functions inherited from Avro.Schema
override string	ToString ()
	Returns the canonical JSON representation of this schema.

string	GetProperty (string key)
	Returns the schema's custom property value given the property name.

override int	GetHashCode ()
	Hash code function.

Static Public Member Functions
static EnumSchema	Create (string name, IEnumerable< string > symbols, string space=null, IEnumerable< string > aliases=null, PropertyMap customProperties=null, string doc=null, string defaultSymbol=null)
	Initializes a new instance of the EnumSchema class.

Static Public Member Functions inherited from Avro.Schema
static Schema	Parse (string json)
	Parses a given JSON string to create a new schema object.

static Schema	Parse (string json, SchemaNames names, string encspace=null)
	Parses a JSON string to create a new schema object.

static string	GetTypeString (Type type)
	Returns symbol name for the given schema type.

static Schema.? Type	ParseType (string type, bool removeQuotes=false)
	Parses the Schema.Type from a string.

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

string	Default `[get]`
	The default token to use when deserializing an enum when the provided token is not found.

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

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

Properties inherited from Avro.NamedSchema
SchemaName	SchemaName `[get]`
	Name of the schema, contains name, namespace and enclosing namespace.

override string	Name `[get]`
	Name of the schema.

string	Namespace `[get]`
	Namespace of the schema.

override string	Fullname `[get]`
	Namespace.Name of the schema.

string	Documentation `[get]`
	Documentation for the schema, if any. Null if there is no documentation.

Properties inherited from Avro.Schema
Type	Tag `[get]`
	Schema type property.

string	Name `[get]`
	If this is a record, enum or fixed, returns its name, otherwise the name the primitive type.

virtual string	Fullname `[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.

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 , Logical }
	Enum for schema types. More...

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

bool	InAliases (SchemaName name)
	Determines whether the given schema name is one of this NamedSchema's aliases.

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

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.

static IList< SchemaName >	GetAliases (JToken jtok, string space, string encspace)
	Parses the 'aliases' property from the given JSON token.

Static Protected Member Functions inherited from Avro.Schema
static bool	areEqual (object o1, object o2)
	Compares two objects, null is equal to null.

static int	getHashCode (object obj)
	Hash code helper function.

Detailed Description

Class for enum type schemas.

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.

◆ 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

◆ Create()

static EnumSchema Avro.EnumSchema.Create	(	string	name,
		IEnumerable< string >	symbols,
		string	space = `null`,
		IEnumerable< string >	aliases = `null`,
		PropertyMap	customProperties = `null`,
		string	doc = `null`,
		string	defaultSymbol = `null`
	)

inlinestatic

Initializes a new instance of the EnumSchema class.

Parameters

name	Name of enum
space	Namespace of enum
aliases	List of aliases for the name
symbols	List of enum symbols
customProperties	Custom properties on this schema
doc	Documentation for this named schema
defaultSymbol

◆ Equals()

override bool Avro.EnumSchema.Equals ( object obj )

inline

Checks equality of two enum schema.

Parameters

obj

Returns

◆ 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

◆ GetHashCode()

override int Avro.EnumSchema.GetHashCode ( )

inline

Hashcode function.

Returns

◆ 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

Exceptions

Avro.AvroException No such symbol: {symbol}

Property Documentation

◆ 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

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

src/apache/main/Schema/EnumSchema.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanRead()

◆ Contains()

◆ Create()

◆ Equals()

◆ GetEnumerator()

◆ GetHashCode()

◆ Ordinal()

Property Documentation

◆ this[int index]