Avro::Field Class Reference

Class for fields defined in a record. More...

List of all members.

Public Types
enum	SortOrder { ascending, descending, ignore }
	Enum for the sorting order of record fields. More...
Public Member Functions
string	GetProperty (string key)
	Returns the field's custom property value given the property name.
override bool	Equals (object obj)
	Compares two field objects.
override int	GetHashCode ()
	Hash code function.
Public Attributes
readonly string	Name
	Name of the field.
readonly IList< string >	aliases
	List of aliases for the field name.
Protected Member Functions
internal void	writeJson (JsonTextWriter writer, SchemaNames names, string encspace)
	Writes the Field class in JSON format.
Properties
int	Pos [get, set]
	Position of the field within its record.
string	Documentation [get, set]
	Documentation for the field, if any. Null if there is no documentation.
JToken	DefaultValue [get, set]
	The default value for the field stored as JSON object, if defined. Otherwise, null.
SortOrder	Ordering [get, set]
	Order of the field.
Schema	Schema [get, set]
	Field type's schema.

---

Detailed Description

Class for fields defined in a record.

---

Member Enumeration Documentation

enum Avro::Field::SortOrder

Enum for the sorting order of record fields.

---

Member Function Documentation

override bool Avro::Field::Equals

(

object

obj

)

[inline]

Compares two field objects.

Parameters:

obj	field to compare with this field

Returns:

true if two fields are equal, false otherwise

override int Avro::Field::GetHashCode

(

)

[inline]

Hash code function.

Returns:

string Avro::Field::GetProperty

(

string

key

)

[inline]

Returns the field's custom property value given the property name.

Parameters:

key	custom property name

Returns:

custom property value

internal void Avro::Field::writeJson	(	JsonTextWriter	writer,
		SchemaNames	names,
		string	encspace
	)		[inline, protected]

Writes the Field class in JSON format.

Parameters:

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

---

Member Data Documentation

readonly IList<string> Avro::Field::aliases

List of aliases for the field name.

readonly string Avro::Field::Name

Name of the field.

---

Property Documentation

JToken Avro::Field::DefaultValue [get, set]

The default value for the field stored as JSON object, if defined. Otherwise, null.

string Avro::Field::Documentation [get, set]

Documentation for the field, if any. Null if there is no documentation.

SortOrder Avro::Field::Ordering [get, set]

Order of the field.

int Avro::Field::Pos [get, set]

Position of the field within its record.

Schema Avro::Field::Schema [get, set]

Field type's schema.

---

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

• src/apache/main/Schema/Field.cs