Package com.google.protobuf

Class TextFormat.Printer

  • Enclosing class:
    TextFormat
    public static final class TextFormat.Printer
extends java.lang.Object
    Helper class for converting protobufs to text.

    • Field Detail

      • escapeNonAscii

        private final boolean escapeNonAscii
        Whether to escape non ASCII characters with backslash and octal.

      • enablingSafeDebugFormat

        private final boolean enablingSafeDebugFormat
        Whether to enable redaction of sensitive fields and introduce randomization. Note that when this is enabled, the output will no longer be deserializable.

      • singleLine

        private final boolean singleLine

    • Constructor Detail

      • Printer

        private Printer​(boolean escapeNonAscii,
                TypeRegistry typeRegistry,
                ExtensionRegistryLite extensionRegistry,
                boolean enablingSafeDebugFormat,
                boolean singleLine)

    • Method Detail

      • escapingNonAscii

        public TextFormat.Printer escapingNonAscii​(boolean escapeNonAscii)
        Return a new Printer instance with the specified escape mode.
        Parameters:
        escapeNonAscii - If true, the new Printer will escape non-ASCII characters (this is the default behavior. If false, the new Printer will print non-ASCII characters as is. In either case, the new Printer still escapes newlines and quotes in strings.
        Returns:
        a new Printer that clones all other configurations from the current TextFormat.Printer, with the escape mode set to the given parameter.

      • enablingSafeDebugFormat

        TextFormat.Printer enablingSafeDebugFormat​(boolean enablingSafeDebugFormat)
        Return a new Printer instance that outputs a redacted and unstable format suitable for debugging.
        Parameters:
        enablingSafeDebugFormat - If true, the new Printer will redact all proto fields that are marked by a debug_redact=true option, and apply an unstable prefix to the output.
        Returns:
        a new Printer that clones all other configurations from the current TextFormat.Printer, with the enablingSafeDebugFormat mode set to the given parameter.

      • emittingSingleLine

        public TextFormat.Printer emittingSingleLine​(boolean singleLine)
        Return a new Printer instance with the specified line formatting status.
        Parameters:
        singleLine - If true, the new Printer will output no newline characters.
        Returns:
        a new Printer that clones all other configurations from the current TextFormat.Printer, with the singleLine mode set to the given parameter.

      • print

        public void print​(MessageOrBuilder message,
                  java.lang.Appendable output)
           throws java.io.IOException
        Outputs a textual 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:
        java.io.IOException

      • print

        public void print​(UnknownFieldSet fields,
                  java.lang.Appendable output)
           throws java.io.IOException
        Outputs a textual representation of fields to output.
        Throws:
        java.io.IOException

      • applyUnstablePrefix

        private void applyUnstablePrefix​(java.lang.Appendable output)

      • printAny

        private boolean printAny​(MessageOrBuilder message,
                         TextFormat.TextGenerator generator)
                  throws java.io.IOException
        Attempt to print the 'google.protobuf.Any' message in a human-friendly format. Returns false if the message isn't a valid 'google.protobuf.Any' message (in which case the message should be rendered just like a regular message to help debugging).
        Throws:
        java.io.IOException

      • printField

        public void printField​(Descriptors.FieldDescriptor field,
                       java.lang.Object value,
                       java.lang.Appendable output)
                throws java.io.IOException
        Throws:
        java.io.IOException

      • printFieldValue

        public void printFieldValue​(Descriptors.FieldDescriptor field,
                            java.lang.Object value,
                            java.lang.Appendable output)
                     throws java.io.IOException
        Outputs a textual representation of the value of given field value.
        Parameters:
        field - the descriptor of the field
        value - the value of the field
        output - the output to which to append the formatted value
        Throws:
        java.lang.ClassCastException - if the value is not appropriate for the given field descriptor
        java.io.IOException - if there is an exception writing to the output

      • printToString

        public java.lang.String printToString​(MessageOrBuilder message)
        Like print(), but writes directly to a String and returns it.

      • printToString

        public java.lang.String printToString​(UnknownFieldSet fields)
        Like print(), but writes directly to a String and returns it.

      • shortDebugString

        @Deprecated
public java.lang.String shortDebugString​(MessageOrBuilder message)
        Deprecated.
        Use this.printer().emittingSingleLine(true).printToString(MessageOrBuilder)
        Generates a human readable form of this message, useful for debugging and other purposes, with no newline characters.

      • shortDebugString

        @Deprecated
@InlineMe(replacement="this.emittingSingleLine(true).printFieldToString(field, value)")
public java.lang.String shortDebugString​(Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Deprecated.
        Use this.emittingSingleLine(true).printFieldToString(FieldDescriptor, Object)
        Generates a human readable form of the field, useful for debugging and other purposes, with no newline characters.

      • shortDebugString

        @Deprecated
@InlineMe(replacement="this.emittingSingleLine(true).printToString(fields)")
public java.lang.String shortDebugString​(UnknownFieldSet fields)
        Deprecated.
        Use this.emittingSingleLine(true).printToString(UnknownFieldSet)
        Generates a human readable form of the unknown fields, useful for debugging and other purposes, with no newline characters.

      • printUnknownFieldValue

        private static void printUnknownFieldValue​(int tag,
                                           java.lang.Object value,
                                           TextFormat.TextGenerator generator,
                                           boolean redact)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • printUnknownFields

        private static void printUnknownFields​(UnknownFieldSet unknownFields,
                                       TextFormat.TextGenerator generator,
                                       boolean redact)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • printUnknownField

        private static void printUnknownField​(int number,
                                      int wireType,
                                      java.util.List<?> values,
                                      TextFormat.TextGenerator generator,
                                      boolean redact)
                               throws java.io.IOException
        Throws:
        java.io.IOException