IDictionaryRepresentationConfigurable.cs 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. /* Copyright 2010-2015 MongoDB Inc.
  2. *
  3. * Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. *
  7. * http://www.apache.org/licenses/LICENSE-2.0
  8. *
  9. * Unless required by applicable law or agreed to in writing, software
  10. * distributed under the License is distributed on an "AS IS" BASIS,
  11. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. * See the License for the specific language governing permissions and
  13. * limitations under the License.
  14. */
  15. using MongoDB.Bson.Serialization.Options;
  16. namespace MongoDB.Bson.Serialization
  17. {
  18. /// <summary>
  19. /// Represents a serializer that has a DictionaryRepresentation property.
  20. /// </summary>
  21. public interface IDictionaryRepresentationConfigurable
  22. {
  23. /// <summary>
  24. /// Gets the dictionary representation.
  25. /// </summary>
  26. /// <value>
  27. /// The dictionary representation.
  28. /// </value>
  29. DictionaryRepresentation DictionaryRepresentation { get; }
  30. /// <summary>
  31. /// Returns a serializer that has been reconfigured with the specified dictionary representation.
  32. /// </summary>
  33. /// <param name="dictionaryRepresentation">The dictionary representation.</param>
  34. /// <returns>The reconfigured serializer.</returns>
  35. IBsonSerializer WithDictionaryRepresentation(DictionaryRepresentation dictionaryRepresentation);
  36. }
  37. /// <summary>
  38. /// Represents a serializer that has a DictionaryRepresentation property.
  39. /// </summary>
  40. /// <typeparam name="TSerializer">The type of the serializer.</typeparam>
  41. public interface IDictionaryRepresentationConfigurable<TSerializer> : IDictionaryRepresentationConfigurable where TSerializer : IBsonSerializer
  42. {
  43. /// <summary>
  44. /// Returns a serializer that has been reconfigured with the specified dictionary representation.
  45. /// </summary>
  46. /// <param name="dictionaryRepresentation">The dictionary representation.</param>
  47. /// <returns>The reconfigured serializer.</returns>
  48. new TSerializer WithDictionaryRepresentation(DictionaryRepresentation dictionaryRepresentation);
  49. }
  50. }