code.grnet.gr Git - pithos-ms-client/blob - trunk/Libraries/Json40r2/Source/Src/Newtonsoft.Json/Serialization/IReferenceResolver.cs

   1 #region License
   2 // Copyright (c) 2007 James Newton-King
   3 //
   4 // Permission is hereby granted, free of charge, to any person
   5 // obtaining a copy of this software and associated documentation
   6 // files (the "Software"), to deal in the Software without
   7 // restriction, including without limitation the rights to use,
   8 // copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 // copies of the Software, and to permit persons to whom the
  10 // Software is furnished to do so, subject to the following
  11 // conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be
  14 // included in all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  18 // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  21 // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23 // OTHER DEALINGS IN THE SOFTWARE.
  24 #endregion
  25
  26 namespace Newtonsoft.Json.Serialization
  27 {
  28   /// <summary>
  29   /// Used to resolve references when serializing and deserializing JSON by the <see cref="JsonSerializer"/>.
  30   /// </summary>
  31   public interface IReferenceResolver
  32   {
  33     /// <summary>
  34     /// Resolves a reference to its object.
  35     /// </summary>
  36     /// <param name="context">The serialization context.</param>
  37     /// <param name="reference">The reference to resolve.</param>
  38     /// <returns>The object that</returns>
  39     object ResolveReference(object context, string reference);
  40     /// <summary>
  41     /// Gets the reference for the sepecified object.
  42     /// </summary>
  43     /// <param name="context">The serialization context.</param>
  44     /// <param name="value">The object to get a reference for.</param>
  45     /// <returns>The reference to the object.</returns>
  46     string GetReference(object context, object value);
  47     /// <summary>
  48     /// Determines whether the specified object is referenced.
  49     /// </summary>
  50     /// <param name="context">The serialization context.</param>
  51     /// <param name="value">The object to test for a reference.</param>
  52     /// <returns>
  53     ///         <c>true</c> if the specified object is referenced; otherwise, <c>false</c>.
  54     /// </returns>
  55     bool IsReferenced(object context, object value);
  56     /// <summary>
  57     /// Adds a reference to the specified object.
  58     /// </summary>
  59     /// <param name="context">The serialization context.</param>
  60     /// <param name="reference">The reference.</param>
  61     /// <param name="value">The object to reference.</param>
  62     void AddReference(object context, string reference, object value);
  63   }
  64 }