#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 LC.Newtonsoft.Json.Serialization;
namespace LC.Newtonsoft.Json
{
///
/// Instructs the to always serialize the member with the specified name.
///
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Parameter, AllowMultiple = false)]
public sealed class JsonPropertyAttribute : Attribute
{
// yuck. can't set nullable properties on an attribute in C#
// have to use this approach to get an unset default state
internal NullValueHandling? _nullValueHandling;
internal DefaultValueHandling? _defaultValueHandling;
internal ReferenceLoopHandling? _referenceLoopHandling;
internal ObjectCreationHandling? _objectCreationHandling;
internal TypeNameHandling? _typeNameHandling;
internal bool? _isReference;
internal int? _order;
internal Required? _required;
internal bool? _itemIsReference;
internal ReferenceLoopHandling? _itemReferenceLoopHandling;
internal TypeNameHandling? _itemTypeNameHandling;
///
/// Gets or sets the type used when serializing the property's collection items.
///
/// The collection's items type.
public Type? ItemConverterType { get; set; }
///
/// The parameter list to use when constructing the described by .
/// If null, the default constructor is used.
/// When non-null, there must be a constructor defined in the that exactly matches the number,
/// order, and type of these parameters.
///
///
///
/// [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
///
///
public object[]? ItemConverterParameters { get; set; }
///
/// Gets or sets the of the .
///
/// The of the .
public Type? NamingStrategyType { get; set; }
///
/// The parameter list to use when constructing the described by .
/// If null, the default constructor is used.
/// When non-null, there must be a constructor defined in the that exactly matches the number,
/// order, and type of these parameters.
///
///
///
/// [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
///
///
public object[]? NamingStrategyParameters { get; set; }
///
/// Gets or sets the null value handling used when serializing this property.
///
/// The null value handling.
public NullValueHandling NullValueHandling
{
get => _nullValueHandling ?? default;
set => _nullValueHandling = value;
}
///
/// Gets or sets the default value handling used when serializing this property.
///
/// The default value handling.
public DefaultValueHandling DefaultValueHandling
{
get => _defaultValueHandling ?? default;
set => _defaultValueHandling = value;
}
///
/// Gets or sets the reference loop handling used when serializing this property.
///
/// The reference loop handling.
public ReferenceLoopHandling ReferenceLoopHandling
{
get => _referenceLoopHandling ?? default;
set => _referenceLoopHandling = value;
}
///
/// Gets or sets the object creation handling used when deserializing this property.
///
/// The object creation handling.
public ObjectCreationHandling ObjectCreationHandling
{
get => _objectCreationHandling ?? default;
set => _objectCreationHandling = value;
}
///
/// Gets or sets the type name handling used when serializing this property.
///
/// The type name handling.
public TypeNameHandling TypeNameHandling
{
get => _typeNameHandling ?? default;
set => _typeNameHandling = value;
}
///
/// Gets or sets whether this property's value is serialized as a reference.
///
/// Whether this property's value is serialized as a reference.
public bool IsReference
{
get => _isReference ?? default;
set => _isReference = value;
}
///
/// Gets or sets the order of serialization of a member.
///
/// The numeric order of serialization.
public int Order
{
get => _order ?? default;
set => _order = value;
}
///
/// Gets or sets a value indicating whether this property is required.
///
///
/// A value indicating whether this property is required.
///
public Required Required
{
get => _required ?? Required.Default;
set => _required = value;
}
///
/// Gets or sets the name of the property.
///
/// The name of the property.
public string? PropertyName { get; set; }
///
/// Gets or sets the reference loop handling used when serializing the property's collection items.
///
/// The collection's items reference loop handling.
public ReferenceLoopHandling ItemReferenceLoopHandling
{
get => _itemReferenceLoopHandling ?? default;
set => _itemReferenceLoopHandling = value;
}
///
/// Gets or sets the type name handling used when serializing the property's collection items.
///
/// The collection's items type name handling.
public TypeNameHandling ItemTypeNameHandling
{
get => _itemTypeNameHandling ?? default;
set => _itemTypeNameHandling = value;
}
///
/// Gets or sets whether this property's collection items are serialized as a reference.
///
/// Whether this property's collection items are serialized as a reference.
public bool ItemIsReference
{
get => _itemIsReference ?? default;
set => _itemIsReference = value;
}
///
/// Initializes a new instance of the class.
///
public JsonPropertyAttribute()
{
}
///
/// Initializes a new instance of the class with the specified name.
///
/// Name of the property.
public JsonPropertyAttribute(string propertyName)
{
PropertyName = propertyName;
}
}
}