com.googlecode.protobuf.format

Class JsonFormat

java.lang.Object

com.googlecode.protobuf.format.ProtobufFormatter

com.googlecode.protobuf.format.AbstractCharBasedFormatter

com.googlecode.protobuf.format.JsonFormat

Direct Known Subclasses:

CouchDBFormat

public class JsonFormat
extends AbstractCharBasedFormatter

Provide ascii text parsing and formatting support for proto2 instances. The implementation largely follows google/protobuf/text_format.cc.

(c) 2009-10 Orbitz World Wide. All Rights Reserved.

Author:

eliran.bivas@gmail.com Eliran Bivas, aantonov@orbitz.com Alex Antonov

Based on the original code by:, wenboz@google.com Wenbo Zhu, kenton@google.com Kenton Varda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JsonFormat.JsonGenerator An inner class for writing text to the output stream.
static class	JsonFormat.ParseException Thrown when parsing an invalid text format message.
protected static class	JsonFormat.Tokenizer Represents a stream of tokens parsed from a String.

Constructor Summary

Constructors

Constructor and Description
JsonFormat()

Method Summary

Modifier and Type	Method and Description
void	merge(CharSequence input, com.google.protobuf.ExtensionRegistry extensionRegistry, com.google.protobuf.Message.Builder builder) Parse a text-format message from input and merge the contents into builder.
protected void	mergeField(JsonFormat.Tokenizer tokenizer, com.google.protobuf.ExtensionRegistry extensionRegistry, com.google.protobuf.Message.Builder builder) Parse a single field from tokenizer and merge it into builder.
void	print(com.google.protobuf.Message message, Appendable output) Outputs a textual representation of the Protocol Message supplied into the parameter output.
protected void	print(com.google.protobuf.Message message, JsonFormat.JsonGenerator generator)
void	print(com.google.protobuf.UnknownFieldSet fields, Appendable output) Outputs a textual representation of fields to output.
void	printField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value, JsonFormat.JsonGenerator generator)
protected void	printUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields, JsonFormat.JsonGenerator generator)

Methods inherited from class com.googlecode.protobuf.format.AbstractCharBasedFormatter

merge, merge, print, print

Methods inherited from class com.googlecode.protobuf.format.ProtobufFormatter

getDefaultCharset, merge, merge, merge, print, print, printToString, printToString, setDefaultCharset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonFormat

public JsonFormat()

Method Detail

print

public void print(com.google.protobuf.Message message,
                  Appendable output)
           throws IOException

Outputs a textual representation of the Protocol Message supplied into the parameter output. (This representation is the new version of the classic "ProtocolPrinter" output from the original Protocol Buffer system)

Specified by:

print in class AbstractCharBasedFormatter

Throws:

IOException

print

public void print(com.google.protobuf.UnknownFieldSet fields,
                  Appendable output)
           throws IOException

Outputs a textual representation of fields to output.

Specified by:

print in class AbstractCharBasedFormatter

Throws:

IOException

print

protected void print(com.google.protobuf.Message message,
                     JsonFormat.JsonGenerator generator)
              throws IOException

Throws:

IOException

printField

public void printField(com.google.protobuf.Descriptors.FieldDescriptor field,
                       Object value,
                       JsonFormat.JsonGenerator generator)
                throws IOException

Throws:

IOException

printUnknownFields

protected void printUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields,
                                  JsonFormat.JsonGenerator generator)
                           throws IOException

Throws:

IOException

merge

public void merge(CharSequence input,
                  com.google.protobuf.ExtensionRegistry extensionRegistry,
                  com.google.protobuf.Message.Builder builder)
           throws JsonFormat.ParseException

Parse a text-format message from input and merge the contents into builder. Extensions will be recognized if they are registered in extensionRegistry.

Specified by:

merge in class AbstractCharBasedFormatter

Throws:

JsonFormat.ParseException

mergeField

protected void mergeField(JsonFormat.Tokenizer tokenizer,
                          com.google.protobuf.ExtensionRegistry extensionRegistry,
                          com.google.protobuf.Message.Builder builder)
                   throws JsonFormat.ParseException

Parse a single field from tokenizer and merge it into builder. If a ',' is detected after the field ends, the next field will be parsed automatically

Throws:

JsonFormat.ParseException