You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.9 KiB

#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
namespace Newtonsoft.Json.Serialization
{
/// <summary>
/// A base class for resolving how property names and dictionary keys are serialized.
/// </summary>
internal abstract class NamingStrategy
{
/// <summary>
/// A flag indicating whether dictionary keys should be processed.
/// Defaults to <c>false</c>.
/// </summary>
public bool ProcessDictionaryKeys { get; set; }
/// <summary>
/// A flag indicating whether extension data names should be processed.
/// Defaults to <c>false</c>.
/// </summary>
public bool ProcessExtensionDataNames { get; set; }
/// <summary>
/// A flag indicating whether explicitly specified property names,
/// e.g. a property name customized with a <see cref="JsonPropertyAttribute"/>, should be processed.
/// Defaults to <c>false</c>.
/// </summary>
public bool OverrideSpecifiedNames { get; set; }
/// <summary>
/// Gets the serialized name for a given property name.
/// </summary>
/// <param name="name">The initial property name.</param>
/// <param name="hasSpecifiedName">A flag indicating whether the property has had a name explicitly specified.</param>
/// <returns>The serialized property name.</returns>
public virtual string GetPropertyName(string name, bool hasSpecifiedName)
{
if (hasSpecifiedName && !OverrideSpecifiedNames)
{
return name;
}
return ResolvePropertyName(name);
}
/// <summary>
/// Gets the serialized name for a given extension data name.
/// </summary>
/// <param name="name">The initial extension data name.</param>
/// <returns>The serialized extension data name.</returns>
public virtual string GetExtensionDataName(string name)
{
if (!ProcessExtensionDataNames)
{
return name;
}
return ResolvePropertyName(name);
}
/// <summary>
/// Gets the serialized key for a given dictionary key.
/// </summary>
/// <param name="key">The initial dictionary key.</param>
/// <returns>The serialized dictionary key.</returns>
public virtual string GetDictionaryKey(string key)
{
if (!ProcessDictionaryKeys)
{
return key;
}
return ResolvePropertyName(key);
}
/// <summary>
/// Resolves the specified property name.
/// </summary>
/// <param name="name">The property name to resolve.</param>
/// <returns>The resolved property name.</returns>
protected abstract string ResolvePropertyName(string name);
}
}