Field.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Text;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json;

namespace Avro
{

    public class Field
    {
        public enum SortOrder
        {
            ascending,
            descending,
            ignore
        }

        public readonly string Name;

        public readonly IList<string> aliases;

        public int Pos { get; private set; }

        public string Documentation { get; private set; }

        public JToken DefaultValue { get; private set; }

        public SortOrder? Ordering { get; private set; }

        public Schema Schema { get; private set; }

        private readonly PropertyMap Props;

        internal static JTokenEqualityComparer JtokenEqual = new JTokenEqualityComparer();


        internal Field(Schema schema, string name, IList<string> aliases, int pos, string doc,
                        JToken defaultValue, SortOrder sortorder, PropertyMap props)
        {
            if (string.IsNullOrEmpty(name)) throw new ArgumentNullException("name", "name cannot be null.");
            if (null == schema) throw new ArgumentNullException("type", "type cannot be null.");
            this.Schema = schema;
            this.Name = name;
            this.aliases = aliases;
            this.Pos = pos;
            this.Documentation = doc;
            this.DefaultValue = defaultValue;
            this.Ordering = sortorder;
            this.Props = props;
        }

        protected internal void writeJson(JsonTextWriter writer, SchemaNames names, string encspace)
        {
            writer.WriteStartObject();
            JsonHelper.writeIfNotNullOrEmpty(writer, "name", this.Name);
            JsonHelper.writeIfNotNullOrEmpty(writer, "doc", this.Documentation);

            if (null != this.DefaultValue)
            {
                writer.WritePropertyName("default");
                this.DefaultValue.WriteTo(writer, null);
            }
            if (null != this.Schema)
            {
                writer.WritePropertyName("type");
                Schema.WriteJson(writer, names, encspace);
            }

            if (null != this.Props)
                this.Props.WriteJson(writer);

            if (null != aliases)
            {
                writer.WritePropertyName("aliases");
                writer.WriteStartArray();
                foreach (string name in aliases)
                    writer.WriteValue(name);
                writer.WriteEndArray();
            }

            writer.WriteEndObject();
        }

        internal static IList<string> GetAliases(JToken jtok)
        {
            JToken jaliases = jtok["aliases"];
            if (null == jaliases)
                return null;

            if (jaliases.Type != JTokenType.Array)
                throw new SchemaParseException("Aliases must be of format JSON array of strings");

            var aliases = new List<string>();
            foreach (JToken jalias in jaliases)
            {
                if (jalias.Type != JTokenType.String)
                    throw new SchemaParseException("Aliases must be of format JSON array of strings");

                aliases.Add((string)jalias);
            }
            return aliases;
        }

        public string GetProperty(string key)
        {
            if (null == this.Props) return null;
            string v;
            return (this.Props.TryGetValue(key, out v)) ? v : null;
        }

        public override bool Equals(object obj)
        {
            if (obj == this) return true;
            if (obj != null && obj is Field)
            {
                Field that = obj as Field;
                return areEqual(that.Name, Name) && that.Pos == Pos && areEqual(that.Documentation, Documentation)
                    && areEqual(that.Ordering, Ordering) && JtokenEqual.Equals(that.DefaultValue, DefaultValue)
                    && that.Schema.Equals(Schema) && areEqual(that.Props, this.Props);
            }
            return false;
        }

        private static bool areEqual(object o1, object o2)
        {
            return o1 == null ? o2 == null : o1.Equals(o2);
        }

        public override int GetHashCode()
        {
            return 17 * Name.GetHashCode() + Pos + 19 * getHashCode(Documentation) +
                   23 * getHashCode(Ordering) + 29 * getHashCode(DefaultValue) + 31 * Schema.GetHashCode() +
                   37 * getHashCode(Props);
        }

        private static int getHashCode(object obj)
        {
            return obj == null ? 0 : obj.GetHashCode();
        }
    }
}