public static class JsonFormat.PrinterA Printer converts protobuf message to JSON format.
Methods
appendTo(MessageOrBuilder message, Appendable output)
public void appendTo(MessageOrBuilder message, Appendable output)Converts a protobuf message to JSON format.
| Parameters | |
|---|---|
| Name | Description |
message |
MessageOrBuilder |
output |
Appendable |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
if the message contains Any types that can't be resolved. |
includingDefaultValueFields()
public JsonFormat.Printer includingDefaultValueFields()Creates a new 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 Printer.
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
includingDefaultValueFields(Set<Descriptors.FieldDescriptor> fieldsToAlwaysOutput)
public JsonFormat.Printer includingDefaultValueFields(Set<Descriptors.FieldDescriptor> fieldsToAlwaysOutput)Creates a new Printer that will also print default-valued fields if their FieldDescriptors are found in the supplied set. Empty repeated fields and map fields will be printed as well, if they match. The new Printer clones all other configurations from the current Printer. Call includingDefaultValueFields() with no args to unconditionally output all fields.
| Parameter | |
|---|---|
| Name | Description |
fieldsToAlwaysOutput |
Set<FieldDescriptor> |
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
omittingInsignificantWhitespace()
public JsonFormat.Printer omittingInsignificantWhitespace()Create a new 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 Printer.
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
preservingProtoFieldNames()
public JsonFormat.Printer preservingProtoFieldNames()Creates a new 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 Printer.
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
print(MessageOrBuilder message)
public String print(MessageOrBuilder message)Converts a protobuf message to JSON format. Throws exceptions if there are unknown Any types in the message.
| Parameter | |
|---|---|
| Name | Description |
message |
MessageOrBuilder |
| Returns | |
|---|---|
| Type | Description |
String |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
printingEnumsAsInts()
public JsonFormat.Printer printingEnumsAsInts()Creates a new Printer that will print enum field values as integers instead of as string. The new Printer clones all other configurations from the current Printer.
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
sortingMapKeys()
public JsonFormat.Printer sortingMapKeys()Create a new Printer that will sort the map keys in the JSON output.
Use of this modifier is discouraged, the generated JSON messages are equivalent with and without this option set, but there are some corner use cases that demand a stable output, while order of map keys is otherwise arbitrary.
The generated order is not well-defined and should not be depended on, but it's stable.
This new Printer clones all other configurations from the current Printer.
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
usingTypeRegistry(TypeRegistry registry)
public JsonFormat.Printer usingTypeRegistry(TypeRegistry registry)Creates a new Printer using the given registry. The new Printer clones all other configurations from the current Printer.
| Parameter | |
|---|---|
| Name | Description |
registry |
TypeRegistry |
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|
usingTypeRegistry(JsonFormat.TypeRegistry oldRegistry)
public JsonFormat.Printer usingTypeRegistry(JsonFormat.TypeRegistry oldRegistry)Creates a new Printer using the given registry. The new Printer clones all other configurations from the current Printer.
| Parameter | |
|---|---|
| Name | Description |
oldRegistry |
JsonFormat.TypeRegistry |
| Returns | |
|---|---|
| Type | Description |
JsonFormat.Printer |
|