Kinetica   C#   API  Version 7.2.3.0
Avro.SchemaNames Class Reference

A class that contains a list of named schemas. More...

Public Member Functions

 SchemaNames ()
 Constructor More...
 
bool Contains (SchemaName name)
 Checks if given name is in the map More...
 
bool Add (SchemaName name, NamedSchema schema)
 Adds a schema name to the map if it doesn't exist yet More...
 
bool Add (NamedSchema schema)
 Adds a named schema to the list More...
 
bool TryGetValue (string name, string space, string encspace, out NamedSchema schema)
 Tries to get the value for the given name fields More...
 
IEnumerator< KeyValuePair< SchemaName, NamedSchema > > GetEnumerator ()
 Returns the enumerator for the map More...
 

Properties

IDictionary< SchemaName, NamedSchemaNames [get]
 Map of schema name and named schema objects More...
 

Detailed Description

A class that contains a list of named schemas.

This is used when reading or writing a schema/protocol. This prevents reading and writing of duplicate schema definitions within a protocol or schema file

Definition at line 146 of file SchemaName.cs.

Constructor & Destructor Documentation

◆ SchemaNames()

Avro.SchemaNames.SchemaNames ( )
inline

Constructor

Definition at line 156 of file SchemaName.cs.

Member Function Documentation

◆ Add() [1/2]

bool Avro.SchemaNames.Add ( SchemaName  name,
NamedSchema  schema 
)
inline

Adds a schema name to the map if it doesn't exist yet

Parameters
nameschema name
schemaschema object
Returns
true if schema was added to the list, false if schema is already in the list

Definition at line 179 of file SchemaName.cs.

◆ Add() [2/2]

bool Avro.SchemaNames.Add ( NamedSchema  schema)
inline

Adds a named schema to the list

Parameters
schemaschema object
Returns
true if schema was added to the list, false if schema is already in the list

Definition at line 193 of file SchemaName.cs.

◆ Contains()

bool Avro.SchemaNames.Contains ( SchemaName  name)
inline

Checks if given name is in the map

Parameters
nameschema name
Returns
true or false

Definition at line 166 of file SchemaName.cs.

◆ GetEnumerator()

IEnumerator<KeyValuePair<SchemaName, NamedSchema> > Avro.SchemaNames.GetEnumerator ( )
inline

Returns the enumerator for the map

Returns

Definition at line 217 of file SchemaName.cs.

◆ TryGetValue()

bool Avro.SchemaNames.TryGetValue ( string  name,
string  space,
string  encspace,
out NamedSchema  schema 
)
inline

Tries to get the value for the given name fields

Parameters
namename of the schema
spacenamespace of the schema
encspaceenclosing namespace of the schema
schemaschema object found
Returns
true if name is found in the map, false otherwise

Definition at line 207 of file SchemaName.cs.

Property Documentation

◆ Names

IDictionary<SchemaName, NamedSchema> Avro.SchemaNames.Names
get

Map of schema name and named schema objects

Definition at line 151 of file SchemaName.cs.


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