Newtonsoft.Json\Linq\JConstructor.cs

#region License

// Copyright (c) 2007 James Newton-King

//

// Permission is hereby granted, free of charge, to any person

// obtaining a copy of this software and associated documentation

// files (the "Software"), to deal in the Software without

// restriction, including without limitation the rights to use,

// copy, modify, merge, publish, distribute, sublicense, and/or sell

// copies of the Software, and to permit persons to whom the

// Software is furnished to do so, subject to the following

// conditions:

//

// The above copyright notice and this permission notice shall be

// included in all copies or substantial portions of the Software.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

// OTHER DEALINGS IN THE SOFTWARE.

#endregion

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Newtonsoft.Json.Utilities;

using System.Globalization;

namespace Newtonsoft.Json.Linq

{

  /// <summary>

  /// Represents a JSON constructor.

  /// </summary>

  public class JConstructor : JContainer

  {

    private string _name;

    /// <summary>

    /// Gets or sets the name of this constructor.

    /// </summary>

    /// <value>The constructor name.</value>

    public string Name

    {

      get { return _name; }

      set { _name = value; }

    }

    /// <summary>

    /// Gets the node type for this <see cref="JToken"/>.

    /// </summary>

    /// <value>The type.</value>

    public override JTokenType Type

    {

      get { return JTokenType.Constructor; }

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JConstructor"/> class.

    /// </summary>

    public JConstructor()

    {

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JConstructor"/> class from another <see cref="JConstructor"/> object.

    /// </summary>

    /// <param name="other">A <see cref="JConstructor"/> object to copy from.</param>

    public JConstructor(JConstructor other)

      : base(other)

    {

      _name = other.Name;

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JConstructor"/> class with the specified name and content.

    /// </summary>

    /// <param name="name">The constructor name.</param>

    /// <param name="content">The contents of the constructor.</param>

    public JConstructor(string name, params object[] content)

      : this(name, (object)content)

    {

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JConstructor"/> class with the specified name and content.

    /// </summary>

    /// <param name="name">The constructor name.</param>

    /// <param name="content">The contents of the constructor.</param>

    public JConstructor(string name, object content)

      : this(name)

    {

      Add(content);

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JConstructor"/> class with the specified name.

    /// </summary>

    /// <param name="name">The constructor name.</param>

    public JConstructor(string name)

    {

      ValidationUtils.ArgumentNotNullOrEmpty(name, "name");

      _name = name;

    }

    internal override bool DeepEquals(JToken node)

    {

      JConstructor c = node as JConstructor;

      return (c != null && _name == c.Name && ContentsEqual(c));

    }

    internal override JToken CloneToken()

    {

      return new JConstructor(this);

    }

    /// <summary>

    /// Writes this token to a <see cref="JsonWriter"/>.

    /// </summary>

    /// <param name="writer">A <see cref="JsonWriter"/> into which this method will write.</param>

    /// <param name="converters">A collection of <see cref="JsonConverter"/> which will be used when writing the token.</param>

    public override void WriteTo(JsonWriter writer, params JsonConverter[] converters)

    {

      writer.WriteStartConstructor(_name);

      foreach (JToken token in Children())

      {

        token.WriteTo(writer, converters);

      }

      writer.WriteEndConstructor();

    }

    /// <summary>

    /// Gets the <see cref="JToken"/> with the specified key.

    /// </summary>

    /// <value>The <see cref="JToken"/> with the specified key.</value>

    public override JToken this[object key]

    {

      get

      {

        ValidationUtils.ArgumentNotNull(key, "o");

        if (!(key is int))

          throw new ArgumentException("Accessed JConstructor values with invalid key value: {0}. Argument position index expected.".FormatWith(CultureInfo.InvariantCulture, MiscellaneousUtils.ToString(key)));

        return GetItem((int)key);

      }

      set

      {

        ValidationUtils.ArgumentNotNull(key, "o");

        if (!(key is int))

          throw new ArgumentException("Set JConstructor values with invalid key value: {0}. Argument position index expected.".FormatWith(CultureInfo.InvariantCulture, MiscellaneousUtils.ToString(key)));

        SetItem((int)key, value);

      }

    }

    internal override int GetDeepHashCode()

    {

      return _name.GetHashCode() ^ ContentsHashCode();

    }

    /// <summary>

    /// Loads an <see cref="JConstructor"/> from a <see cref="JsonReader"/>. 

    /// </summary>

    /// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JConstructor"/>.</param>

    /// <returns>A <see cref="JConstructor"/> that contains the JSON that was read from the specified <see cref="JsonReader"/>.</returns>

    public static JConstructor Load(JsonReader reader)

    {

      if (reader.TokenType == JsonToken.None)

      {

        if (!reader.Read())

          throw new Exception("Error reading JConstructor from JsonReader.");

      }

      if (reader.TokenType != JsonToken.StartConstructor)

        throw new Exception("Error reading JConstructor from JsonReader. Current JsonReader item is not a constructor: {0}".FormatWith(CultureInfo.InvariantCulture, reader.TokenType));

      JConstructor c = new JConstructor((string)reader.Value);

      c.SetLineInfo(reader as IJsonLineInfo);

      if (!reader.Read())

        throw new Exception("Error reading JConstructor from JsonReader.");

      c.ReadContentFrom(reader);

      return c;

    }

  }

}