IRepresentationConfigurable.cs 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. /* Copyright 2010-2014 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. namespace MongoDB.Bson.Serialization
  16. {
  17. /// <summary>
  18. /// Represents a serializer that has a Representation property.
  19. /// </summary>
  20. public interface IRepresentationConfigurable
  21. {
  22. /// <summary>
  23. /// Gets the representation.
  24. /// </summary>
  25. /// <value>
  26. /// The representation.
  27. /// </value>
  28. BsonType Representation { get; }
  29. /// <summary>
  30. /// Returns a serializer that has been reconfigured with the specified representation.
  31. /// </summary>
  32. /// <param name="representation">The representation.</param>
  33. /// <returns>The reconfigured serializer.</returns>
  34. IBsonSerializer WithRepresentation(BsonType representation);
  35. }
  36. /// <summary>
  37. /// Represents a serializer that has a Representation property.
  38. /// </summary>
  39. /// <typeparam name="TSerializer">The type of the serializer.</typeparam>
  40. public interface IRepresentationConfigurable<TSerializer> : IRepresentationConfigurable where TSerializer : IBsonSerializer
  41. {
  42. /// <summary>
  43. /// Returns a serializer that has been reconfigured with the specified representation.
  44. /// </summary>
  45. /// <param name="representation">The representation.</param>
  46. /// <returns>The reconfigured serializer.</returns>
  47. new TSerializer WithRepresentation(BsonType representation);
  48. }
  49. }