Class JsonFormat.PrinterImpl

java.lang.Object

com.google.protobuf.util.JsonFormat.PrinterImpl

Enclosing class:

JsonFormat

private static final class JsonFormat.PrinterImpl
extends Object

A Printer converts protobuf messages to the ProtoJSON format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	JsonFormat.PrinterImpl.GsonHolder
private static interface	JsonFormat.PrinterImpl.WellKnownTypePrinter

Field Summary

Fields

Modifier and Type	Field	Description
private final CharSequence	blankOrSpace
private final ExtensionRegistry	extensionRegistry
private final JsonFormat.TextGenerator	generator
private final com.google.gson.Gson	gson
private final Set<Descriptors.FieldDescriptor>	includingDefaultValueFields
private final JsonFormat.TypeRegistry	oldRegistry
private final boolean	preservingProtoFieldNames
private final boolean	printingEnumsAsInts
private final boolean	printingFullyQualifiedExtensionNames
private final TypeRegistry	registry
private static final String[]	replacementChars
private final JsonFormat.ShouldPrintDefaults	shouldPrintDefaults
private final boolean	sortingMapKeys
private static final Map<String, JsonFormat.PrinterImpl.WellKnownTypePrinter>	wellKnownTypePrinters

Constructor Summary

Constructors

Constructor

Description

PrinterImpl(TypeRegistry registry, JsonFormat.TypeRegistry oldRegistry, ExtensionRegistry extensionRegistry, JsonFormat.ShouldPrintDefaults shouldPrintDefaults, Set<Descriptors.FieldDescriptor> includingDefaultValueFields, boolean preservingProtoFieldNames, Appendable jsonOutput, boolean omittingInsignificantWhitespace, boolean printingEnumsAsInts, boolean sortingMapKeys, boolean printingFullyQualifiedExtensionNames)

Method Summary

Modifier and Type	Method	Description
private static Map<String, JsonFormat.PrinterImpl.WellKnownTypePrinter>	buildWellKnownTypePrinters()
private static String	getReplacementOrNull(char c)	If a character needs to be escaped, returns the replacement string.
(package private) void	print(MessageOrBuilder message)
private void	print(MessageOrBuilder message, String typeUrl)	Prints a regular message with an optional type URL.
private void	printAny(MessageOrBuilder message)	Prints google.protobuf.Any
private void	printDuration(MessageOrBuilder message)	Prints google.protobuf.Duration
private void	printField(Descriptors.FieldDescriptor field, Object value)
private void	printFieldMask(MessageOrBuilder message)	Prints google.protobuf.FieldMask
private void	printListValue(MessageOrBuilder message)	Prints google.protobuf.ListValue
private void	printListValueConcrete(ListValueOrBuilder message)	Prints `google.protobuf.ListValue` using the concrete generated type.
private void	printListValueReflectively(MessageOrBuilder message)	Prints `google.protobuf.ListValue` using reflection (generally only needed for DynamicMessage)
private void	printMapFieldValue(Descriptors.FieldDescriptor field, Object value)
private void	printRepeatedFieldValue(Descriptors.FieldDescriptor field, Object value)
private void	printSingleFieldValue(Descriptors.FieldDescriptor field, Object value)
private void	printSingleFieldValue(Descriptors.FieldDescriptor field, Object value, boolean alwaysWithQuotes)	Prints a field's value in the ProtoJSON format.
private void	printStringEscapedAndQuoted(CharSequence value)	Prints a string value wrapped in double quotes, escaping any illegal or dangerous characters for JSON safety.
private void	printStruct(MessageOrBuilder message)	Prints google.protobuf.Struct
private void	printStructConcrete(StructOrBuilder message)	Prints the `google.protobuf.Struct` using the concrete generated class.
private void	printStructReflectively(MessageOrBuilder message)	Prints the `google.protobuf.Struct` using reflection only.
private void	printTimestamp(MessageOrBuilder message)	Prints google.protobuf.Timestamp
private void	printValue(MessageOrBuilder message)	Prints `google.protobuf.Value`.
private void	printValueConcrete(ValueOrBuilder message)	Prints `google.protobuf.Value` using the concrete generated type.
private void	printValueReflectively(MessageOrBuilder message)	Prints google.protobuf.Value using reflection (generally only needed for DynamicMessage)
private void	printWrapper(MessageOrBuilder message)	Prints wrapper types (e.g., google.protobuf.Int32Value)
private boolean	shouldSpeciallyPrint(Descriptors.FieldDescriptor field)
private ByteString	toByteString(MessageOrBuilder message)

Methods inherited from class Object

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

Field Details

registry

private final TypeRegistry registry

oldRegistry

private final JsonFormat.TypeRegistry oldRegistry

extensionRegistry

private final ExtensionRegistry extensionRegistry

shouldPrintDefaults

private final JsonFormat.ShouldPrintDefaults shouldPrintDefaults

includingDefaultValueFields

private final Set<Descriptors.FieldDescriptor> includingDefaultValueFields

preservingProtoFieldNames

private final boolean preservingProtoFieldNames

printingEnumsAsInts

private final boolean printingEnumsAsInts

sortingMapKeys

private final boolean sortingMapKeys

printingFullyQualifiedExtensionNames

private final boolean printingFullyQualifiedExtensionNames

generator

private final JsonFormat.TextGenerator generator

gson

private final com.google.gson.Gson gson

blankOrSpace

private final CharSequence blankOrSpace

wellKnownTypePrinters

private static final Map<String, JsonFormat.PrinterImpl.WellKnownTypePrinter> wellKnownTypePrinters

replacementChars

private static final String[] replacementChars

Constructor Details

PrinterImpl

PrinterImpl(TypeRegistry registry,
 JsonFormat.TypeRegistry oldRegistry,
 ExtensionRegistry extensionRegistry,
 JsonFormat.ShouldPrintDefaults shouldPrintDefaults,
 Set<Descriptors.FieldDescriptor> includingDefaultValueFields,
 boolean preservingProtoFieldNames,
 Appendable jsonOutput,
 boolean omittingInsignificantWhitespace,
 boolean printingEnumsAsInts,
 boolean sortingMapKeys,
 boolean printingFullyQualifiedExtensionNames)

Method Details

print

void print(MessageOrBuilder message)
    throws IOException

Throws:

IOException

buildWellKnownTypePrinters

private static Map<String, JsonFormat.PrinterImpl.WellKnownTypePrinter> buildWellKnownTypePrinters()

printAny

private void printAny(MessageOrBuilder message)
               throws IOException

Prints google.protobuf.Any

Throws:

IOException

printWrapper

private void printWrapper(MessageOrBuilder message)
                   throws IOException

Prints wrapper types (e.g., google.protobuf.Int32Value)

Throws:

IOException

toByteString

private ByteString toByteString(MessageOrBuilder message)

printTimestamp

private void printTimestamp(MessageOrBuilder message)
                     throws IOException

Prints google.protobuf.Timestamp

Throws:

IOException

printDuration

private void printDuration(MessageOrBuilder message)
                    throws IOException

Prints google.protobuf.Duration

Throws:

IOException

printFieldMask

private void printFieldMask(MessageOrBuilder message)
                     throws IOException

Prints google.protobuf.FieldMask

Throws:

IOException

printStruct

private void printStruct(MessageOrBuilder message)
                  throws IOException

Prints google.protobuf.Struct

Throws:

IOException

printStructConcrete

private void printStructConcrete(StructOrBuilder message)
                          throws IOException

Prints the `google.protobuf.Struct` using the concrete generated class.

Throws:

IOException

printStructReflectively

private void printStructReflectively(MessageOrBuilder message)
                              throws IOException

Prints the `google.protobuf.Struct` using reflection only. This should only be used for DynamicMessage usecases.

Throws:

IOException

printValue

private void printValue(MessageOrBuilder message)
                 throws IOException

Prints `google.protobuf.Value`.

Throws:

IOException

printValueConcrete

private void printValueConcrete(ValueOrBuilder message)
                         throws IOException

Prints `google.protobuf.Value` using the concrete generated type.

Throws:

IOException

printValueReflectively

private void printValueReflectively(MessageOrBuilder message)
                             throws IOException

Prints google.protobuf.Value using reflection (generally only needed for DynamicMessage)

Throws:

IOException

printListValue

private void printListValue(MessageOrBuilder message)
                     throws IOException

Prints google.protobuf.ListValue

Throws:

IOException

printListValueConcrete

private void printListValueConcrete(ListValueOrBuilder message)
                             throws IOException

Prints `google.protobuf.ListValue` using the concrete generated type.

Throws:

IOException

printListValueReflectively

private void printListValueReflectively(MessageOrBuilder message)
                                 throws IOException

Prints `google.protobuf.ListValue` using reflection (generally only needed for DynamicMessage)

Throws:

IOException

shouldSpeciallyPrint

private boolean shouldSpeciallyPrint(Descriptors.FieldDescriptor field)

Returns:

Whether a set option means the corresponding field should be printed even if it normally wouldn't be.

print

private void print(MessageOrBuilder message,
 @Nullable
 String typeUrl)
            throws IOException

Prints a regular message with an optional type URL.

Throws:

IOException

printField

private void printField(Descriptors.FieldDescriptor field,
 Object value)
                 throws IOException

Throws:

IOException

printRepeatedFieldValue

private void printRepeatedFieldValue(Descriptors.FieldDescriptor field,
 Object value)
                              throws IOException

Throws:

IOException

printMapFieldValue

private void printMapFieldValue(Descriptors.FieldDescriptor field,
 Object value)
                         throws IOException

Throws:

IOException

printSingleFieldValue

private void printSingleFieldValue(Descriptors.FieldDescriptor field,
 Object value)
                            throws IOException

Throws:

IOException

printSingleFieldValue

private void printSingleFieldValue(Descriptors.FieldDescriptor field,
 Object value,
 boolean alwaysWithQuotes)
                            throws IOException

Prints a field's value in the ProtoJSON format.

Parameters:

alwaysWithQuotes - whether to always add double-quotes to primitive types

Throws:

IOException

getReplacementOrNull

private static String getReplacementOrNull(char c)

If a character needs to be escaped, returns the replacement string. Otherwise, returns null.

printStringEscapedAndQuoted

private void printStringEscapedAndQuoted(CharSequence value)
                                  throws IOException

Prints a string value wrapped in double quotes, escaping any illegal or dangerous characters for JSON safety.

Throws:

IOException