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