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 31 #ifndef GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__ 32 #define GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__ 33 34 #include <google/protobuf/stubs/common.h> 35 #include <google/protobuf/stubs/stringpiece.h> 36 #include <google/protobuf/stubs/status.h> 37 38 #include <google/protobuf/port_def.inc> 39 40 namespace google { 41 namespace protobuf { 42 namespace util { 43 namespace converter { 44 45 class ObjectWriter; 46 47 // An ObjectSource is anything that can write to an ObjectWriter. 48 // Implementation of this interface typically provide constructors or 49 // factory methods to create an instance based on some source data, for 50 // example, a character stream, or protobuf. 51 // 52 // Derived classes could be thread-unsafe. 53 class PROTOBUF_EXPORT ObjectSource { 54 public: ~ObjectSource()55 virtual ~ObjectSource() {} 56 57 // Writes to the ObjectWriter WriteTo(ObjectWriter * ow)58 virtual util::Status WriteTo(ObjectWriter* ow) const { 59 return NamedWriteTo("", ow); 60 } 61 62 // Writes to the ObjectWriter with a custom name for the message. 63 // This is useful when you chain ObjectSource together by embedding one 64 // within another. 65 virtual util::Status NamedWriteTo(StringPiece name, 66 ObjectWriter* ow) const = 0; 67 68 protected: ObjectSource()69 ObjectSource() {} 70 71 private: 72 // Do not add any data members to this class. 73 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ObjectSource); 74 }; 75 76 } // namespace converter 77 } // namespace util 78 } // namespace protobuf 79 } // namespace google 80 81 #include <google/protobuf/port_undef.inc> 82 83 #endif // GOOGLE_PROTOBUF_UTIL_CONVERTER_OBJECT_SOURCE_H__ 84