com.google.protobuf.util

Class JsonFormat.Printer

java.lang.Object

com.google.protobuf.util.JsonFormat.Printer

Enclosing class:

JsonFormat

public static class JsonFormat.Printer
extends Object

A Printer converts protobuf message to JSON format.

Method Summary

Modifier and Type	Method and Description
void	appendTo(com.google.protobuf.MessageOrBuilder message, Appendable output) Converts a protobuf message to JSON format.
JsonFormat.Printer	includingDefaultValueFields() Creates a new JsonFormat.Printer that will also print fields set to their defaults.
JsonFormat.Printer	omittingInsignificantWhitespace() Create a new JsonFormat.Printer that will omit all insignificant whitespace in the JSON output.
JsonFormat.Printer	preservingProtoFieldNames() Creates a new JsonFormat.Printer that is configured to use the original proto field names as defined in the .proto file rather than converting them to lowerCamelCase.
String	print(com.google.protobuf.MessageOrBuilder message) Converts a protobuf message to JSON format.
JsonFormat.Printer	usingTypeRegistry(JsonFormat.TypeRegistry registry) Creates a new JsonFormat.Printer using the given registry.

Methods inherited from class java.lang.Object

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

Method Detail

usingTypeRegistry

public JsonFormat.Printer usingTypeRegistry(JsonFormat.TypeRegistry registry)

Creates a new JsonFormat.Printer using the given registry. The new Printer clones all other configurations from the current JsonFormat.Printer.

Throws:

IllegalArgumentException - if a registry is already set.

includingDefaultValueFields

public JsonFormat.Printer includingDefaultValueFields()

Creates a new JsonFormat.Printer that will also print fields set to their defaults. Empty repeated fields and map fields will be printed as well. The new Printer clones all other configurations from the current JsonFormat.Printer.

preservingProtoFieldNames

public JsonFormat.Printer preservingProtoFieldNames()

Creates a new JsonFormat.Printer that is configured to use the original proto field names as defined in the .proto file rather than converting them to lowerCamelCase. The new Printer clones all other configurations from the current JsonFormat.Printer.

omittingInsignificantWhitespace

public JsonFormat.Printer omittingInsignificantWhitespace()

Create a new JsonFormat.Printer that will omit all insignificant whitespace in the JSON output. This new Printer clones all other configurations from the current Printer. Insignificant whitespace is defined by the JSON spec as whitespace that appear between JSON structural elements:

 ws = *(
 %x20 /              ; Space
 %x09 /              ; Horizontal tab
 %x0A /              ; Line feed or New line
 %x0D )              ; Carriage return
 

See https://tools.ietf.org/html/rfc7159 current JsonFormat.Printer.

appendTo

public void appendTo(com.google.protobuf.MessageOrBuilder message,
                     Appendable output)
              throws IOException

Converts a protobuf message to JSON format.

Throws:

com.google.protobuf.InvalidProtocolBufferException - if the message contains Any types that can't be resolved.

IOException - if writing to the output fails.

print

public String print(com.google.protobuf.MessageOrBuilder message)
             throws com.google.protobuf.InvalidProtocolBufferException

Converts a protobuf message to JSON format. Throws exceptions if there are unknown Any types in the message.

Throws:

com.google.protobuf.InvalidProtocolBufferException