Package 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 a protobuf message to the proto3 JSON format.

  • Field Details

    • registry

      private final TypeRegistry registry

    • oldRegistry

      private final JsonFormat.TypeRegistry oldRegistry

    • shouldPrintDefaults

      private final JsonFormat.ShouldPrintDefaults shouldPrintDefaults

    • includingDefaultValueFields

      private final Set<Descriptors.FieldDescriptor> includingDefaultValueFields

    • preservingProtoFieldNames

      private final boolean preservingProtoFieldNames

    • omittingInsignificantWhitespace

      private final boolean omittingInsignificantWhitespace

    • printingEnumsAsInts

      private final boolean printingEnumsAsInts

    • sortingMapKeys

      private final boolean sortingMapKeys

  • Constructor Details

  • Method Details

    • usingTypeRegistry

      public JsonFormat.Printer usingTypeRegistry(JsonFormat.TypeRegistry oldRegistry)
      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

    • usingTypeRegistry

      public JsonFormat.Printer usingTypeRegistry(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

      @Deprecated public JsonFormat.Printer includingDefaultValueFields()
      Deprecated.
      This method is deprecated, and slated for removal in the next Java breaking change (5.x). Prefer alwaysPrintFieldsWithNoPresence()
      Creates a new JsonFormat.Printer that will always print fields unless they are a message type or in a oneof.

      Note that this does print Proto2 Optional but does not print Proto3 Optional fields, as the latter is represented using a synthetic oneof.

      The new Printer clones all other configurations from the current JsonFormat.Printer.

    • includingDefaultValueFields

      public JsonFormat.Printer includingDefaultValueFields(Set<Descriptors.FieldDescriptor> fieldsToAlwaysOutput)
      Creates a new JsonFormat.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 JsonFormat.Printer. Call includingDefaultValueFields() with no args to unconditionally output all fields.

      Note that non-repeated message fields or fields in a oneof are not honored if provided here.

    • alwaysPrintFieldsWithNoPresence

      public JsonFormat.Printer alwaysPrintFieldsWithNoPresence()
      Creates a new JsonFormat.Printer that will print any field that does not support presence even if it would not otherwise be printed (empty repeated fields, empty map fields, and implicit presence scalars set to their default value). The new Printer clones all other configurations from the current JsonFormat.Printer.

    • printingEnumsAsInts

      public JsonFormat.Printer printingEnumsAsInts()
      Creates a new JsonFormat.Printer that prints enum field values as integers instead of as string. The new Printer clones all other configurations from the current JsonFormat.Printer.

    • checkUnsetPrintingEnumsAsInts

      private void checkUnsetPrintingEnumsAsInts()

    • 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 omits 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 appears 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.

    • sortingMapKeys

      public JsonFormat.Printer sortingMapKeys()
      Create a new JsonFormat.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 JsonFormat.Printer.

    • appendTo

      public void appendTo(MessageOrBuilder message, Appendable output) throws IOException
      Converts a protobuf message to the proto3 JSON format.
      Throws:
      InvalidProtocolBufferException - if the message contains Any types that can't be resolved
      IOException - if writing to the output fails

    • print

      public String print(MessageOrBuilder message) throws InvalidProtocolBufferException
      Converts a protobuf message to the proto3 JSON format. Throws exceptions if there are unknown Any types in the message.
      Throws:
      InvalidProtocolBufferException