com.googlecode.protobuf.format

Class XmlJavaxFormat

java.lang.Object

com.googlecode.protobuf.format.ProtobufFormatter

com.googlecode.protobuf.format.XmlJavaxFormat

public class XmlJavaxFormat
extends ProtobufFormatter

(c) 2011 Neustar, Inc. All Rights Reserved.

Author:

jeffrey.damick@neustar.biz Jeffrey Damick Based on the original code by:, eliran.bivas@gmail.com Eliran Bivas, aantonov@orbitz.com Alex Antonov

, wenboz@google.com Wenbo Zhu, kenton@google.com Kenton Varda

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.protobuf.format.ProtobufFormatter

ProtobufFormatter.ParseException

Constructor Summary

Constructors

Constructor and Description
XmlJavaxFormat()

Method Summary

Modifier and Type	Method and Description
protected XMLStreamWriter	createGenerator(OutputStream output)
void	merge(InputStream input, Charset cs, com.google.protobuf.ExtensionRegistry extensionRegistry, com.google.protobuf.Message.Builder builder) Parse a text-format message from input and merge the contents into builder.
void	merge(XMLEventReader parser, 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(XMLEventReader parser, XMLEvent fieldEvent, com.google.protobuf.ExtensionRegistry extensionRegistry, com.google.protobuf.Message.Builder builder) Parse a single field from parser and merge it into builder.
void	print(com.google.protobuf.Message message, OutputStream output, Charset cs) Outputs a Smile representation of the Protocol Message supplied into the parameter output.
void	print(com.google.protobuf.Message message, XMLStreamWriter generator) Outputs a Smile representation of the Protocol Message supplied into the parameter output.
void	print(com.google.protobuf.UnknownFieldSet fields, OutputStream output, Charset cs) Outputs a Smile representation of fields to output.
void	printField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value, XMLStreamWriter generator)
protected void	printMessage(com.google.protobuf.Message message, XMLStreamWriter generator)
protected void	printUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields, XMLStreamWriter generator)

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

XmlJavaxFormat

public XmlJavaxFormat()

Method Detail

print

public void print(com.google.protobuf.Message message,
                  OutputStream output,
                  Charset cs)
           throws IOException

Outputs a Smile 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 ProtobufFormatter

Parameters:

message - the protobuf message to format

output - the stream to write the formatted message

cs - the character set to use

Throws:

IOException

print

public void print(com.google.protobuf.Message message,
                  XMLStreamWriter generator)
           throws IOException

Outputs a Smile 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)

Throws:

IOException

print

public void print(com.google.protobuf.UnknownFieldSet fields,
                  OutputStream output,
                  Charset cs)
           throws IOException

Outputs a Smile representation of fields to output.

Specified by:

print in class ProtobufFormatter

Parameters:

fields - unknown fields to format

output - output the stream to write the formatted message

cs - the character set to use

Throws:

IOException

merge

public void merge(InputStream input,
                  Charset cs,
                  com.google.protobuf.ExtensionRegistry extensionRegistry,
                  com.google.protobuf.Message.Builder builder)
           throws IOException

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 ProtobufFormatter

Throws:

IOException

merge

public void merge(XMLEventReader parser,
                  com.google.protobuf.ExtensionRegistry extensionRegistry,
                  com.google.protobuf.Message.Builder builder)
           throws IOException

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

Throws:

IOException

createGenerator

protected XMLStreamWriter createGenerator(OutputStream output)
                                   throws XMLStreamException

Throws:

XMLStreamException

printMessage

protected void printMessage(com.google.protobuf.Message message,
                            XMLStreamWriter generator)
                     throws XMLStreamException,
                            IOException

Throws:

XMLStreamException

IOException

printField

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

Throws:

IOException

printUnknownFields

protected void printUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields,
                                  XMLStreamWriter generator)
                           throws XMLStreamException

Throws:

XMLStreamException

mergeField

protected void mergeField(XMLEventReader parser,
                          XMLEvent fieldEvent,
                          com.google.protobuf.ExtensionRegistry extensionRegistry,
                          com.google.protobuf.Message.Builder builder)
                   throws XMLStreamException

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

Throws:

XMLStreamException