object_source.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. #ifndef GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__
  31. #define GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__
  32. #include <google/protobuf/stubs/common.h>
  33. #include <google/protobuf/stubs/stringpiece.h>
  34. #include <google/protobuf/stubs/status.h>
  35. namespace google {
  36. namespace protobuf {
  37. namespace util {
  38. namespace converter {
  39. class ObjectWriter;
  40. // An ObjectSource is anything that can write to an ObjectWriter.
  41. // Implementation of this interface typically provide constructors or
  42. // factory methods to create an instance based on some source data, for
  43. // example, a character stream, or protobuf.
  44. //
  45. // Derived classes could be thread-unsafe.
  46. class LIBPROTOBUF_EXPORT ObjectSource {
  47. public:
  48. virtual ~ObjectSource() {}
  49. // Writes to the ObjectWriter
  50. virtual util::Status WriteTo(ObjectWriter* ow) const {
  51. return NamedWriteTo("", ow);
  52. }
  53. // Writes to the ObjectWriter with a custom name for the message.
  54. // This is useful when you chain ObjectSource together by embedding one
  55. // within another.
  56. virtual util::Status NamedWriteTo(StringPiece name,
  57. ObjectWriter* ow) const = 0;
  58. protected:
  59. ObjectSource() {}
  60. private:
  61. // Do not add any data members to this class.
  62. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ObjectSource);
  63. };
  64. } // namespace converter
  65. } // namespace util
  66. } // namespace protobuf
  67. } // namespace google
  68. #endif // GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__