Newtonsoft.Json\JsonContainerAttribute.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;

namespace Newtonsoft.Json

{

  /// <summary>

  /// Instructs the <see cref="JsonSerializer"/> how to serialize the object.

  /// </summary>

  [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface, AllowMultiple = false)]

  public abstract class JsonContainerAttribute : Attribute

  {

    /// <summary>

    /// Gets or sets the id.

    /// </summary>

    /// <value>The id.</value>

    public string Id { get; set; }

    /// <summary>

    /// Gets or sets the title.

    /// </summary>

    /// <value>The title.</value>

    public string Title { get; set; }

    /// <summary>

    /// Gets or sets the description.

    /// </summary>

    /// <value>The description.</value>

    public string Description { get; set; }

    // yuck. can't set nullable properties on an attribute in C#

    // have to use this approach to get an unset default state

    internal bool? _isReference;

    /// <summary>

    /// Gets or sets a value that indicates whether to preserve object reference data.

    /// </summary>

    /// <value>

    /// 	<c>true</c> to keep object reference; otherwise, <c>false</c>. The default is <c>false</c>.

    /// </value>

    public bool IsReference

    {

      get { return _isReference ?? default(bool); }

      set { _isReference = value; }

    }

    /// <summary>

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

    /// </summary>

    protected JsonContainerAttribute()

    {

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="JsonContainerAttribute"/> class with the specified container Id.

    /// </summary>

    /// <param name="id">The container Id.</param>

    protected JsonContainerAttribute(string id)

    {

      Id = id;

    }

  }

}