Package com.google.protobuf

Class TextFormat.Printer

java.lang.Object

com.google.protobuf.TextFormat.Printer

Enclosing class:

TextFormat

public static final class TextFormat.Printer
extends Object

Helper class for converting protobufs to text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TextFormat.Printer.MapEntryAdapter	An adapter class that can take a MapEntry and returns its key and entry.

Field Summary

Fields

Modifier and Type	Field	Description
private static final TextFormat.Printer	DEFAULT
private final boolean	enablingSafeDebugFormat	Whether to enable redaction of sensitive fields and introduce randomization.
private final boolean	escapeNonAscii	Whether to escape non ASCII characters with backslash and octal.
private final ExtensionRegistryLite	extensionRegistry
private final boolean	singleLine
private final TypeRegistry	typeRegistry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Printer(boolean escapeNonAscii, TypeRegistry typeRegistry, ExtensionRegistryLite extensionRegistry, boolean enablingSafeDebugFormat, boolean singleLine)

Method Summary

Modifier and Type	Method	Description
private void	applyUnstablePrefix(Appendable output)
TextFormat.Printer	emittingSingleLine(boolean singleLine)	Return a new Printer instance with the specified line formatting status.
(package private) TextFormat.Printer	enablingSafeDebugFormat(boolean enablingSafeDebugFormat)	Return a new Printer instance that outputs a redacted and unstable format suitable for debugging.
TextFormat.Printer	escapingNonAscii(boolean escapeNonAscii)	Return a new Printer instance with the specified escape mode.
private void	print(MessageOrBuilder message, TextFormat.TextGenerator generator)
void	print(MessageOrBuilder message, Appendable output)	Outputs a textual representation of the Protocol Message supplied into the parameter output.
void	print(UnknownFieldSet fields, Appendable output)	Outputs a textual representation of fields to output.
private boolean	printAny(MessageOrBuilder message, TextFormat.TextGenerator generator)	Attempt to print the 'google.protobuf.Any' message in a human-friendly format.
private void	printField(Descriptors.FieldDescriptor field, Object value, TextFormat.TextGenerator generator)
void	printField(Descriptors.FieldDescriptor field, Object value, Appendable output)
String	printFieldToString(Descriptors.FieldDescriptor field, Object value)
private void	printFieldValue(Descriptors.FieldDescriptor field, Object value, TextFormat.TextGenerator generator)
void	printFieldValue(Descriptors.FieldDescriptor field, Object value, Appendable output)	Outputs a textual representation of the value of given field value.
private void	printMessage(MessageOrBuilder message, TextFormat.TextGenerator generator)
private void	printSingleField(Descriptors.FieldDescriptor field, Object value, TextFormat.TextGenerator generator)
String	printToString(MessageOrBuilder message)	Like print(), but writes directly to a String and returns it.
String	printToString(UnknownFieldSet fields)	Like print(), but writes directly to a String and returns it.
private static void	printUnknownField(int number, int wireType, List<?> values, TextFormat.TextGenerator generator, boolean redact)
private static void	printUnknownFields(UnknownFieldSet unknownFields, TextFormat.TextGenerator generator, boolean redact)
private static void	printUnknownFieldValue(int tag, Object value, TextFormat.TextGenerator generator, boolean redact)
String	shortDebugString(Descriptors.FieldDescriptor field, Object value)	Deprecated. Use this.emittingSingleLine(true).printFieldToString(FieldDescriptor, Object)
String	shortDebugString(MessageOrBuilder message)	Deprecated. Use this.printer().emittingSingleLine(true).printToString(MessageOrBuilder)
String	shortDebugString(UnknownFieldSet fields)	Deprecated. Use this.emittingSingleLine(true).printToString(UnknownFieldSet)
private boolean	shouldRedact(Descriptors.FieldDescriptor field)
private boolean	shouldRedactOptionValue(Descriptors.EnumValueDescriptor optionValue)
TextFormat.Printer	usingExtensionRegistry(ExtensionRegistryLite extensionRegistry)	Creates a new TextFormat.Printer using the given extensionRegistry.
TextFormat.Printer	usingTypeRegistry(TypeRegistry typeRegistry)	Creates a new TextFormat.Printer using the given typeRegistry.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

private static final TextFormat.Printer DEFAULT

escapeNonAscii

private final boolean escapeNonAscii

Whether to escape non ASCII characters with backslash and octal.

typeRegistry

private final TypeRegistry typeRegistry

extensionRegistry

private final ExtensionRegistryLite extensionRegistry

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 Details

Printer

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

Method Details

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.

usingTypeRegistry

public TextFormat.Printer usingTypeRegistry(TypeRegistry typeRegistry)

Creates a new TextFormat.Printer using the given typeRegistry. The new Printer clones all other configurations from the current TextFormat.Printer.

Throws:

IllegalArgumentException - if a registry is already set.

usingExtensionRegistry

public TextFormat.Printer usingExtensionRegistry(ExtensionRegistryLite extensionRegistry)

Creates a new TextFormat.Printer using the given extensionRegistry. The new Printer clones all other configurations from the current TextFormat.Printer.

Throws:

IllegalArgumentException - if a registry is already set.

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,
 Appendable output)
           throws 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:

IOException

print

public void print(UnknownFieldSet fields,
 Appendable output)
           throws IOException

Outputs a textual representation of fields to output.

Throws:

IOException

print

private void print(MessageOrBuilder message,
 TextFormat.TextGenerator generator)
            throws IOException

Throws:

IOException

applyUnstablePrefix

private void applyUnstablePrefix(Appendable output)

printAny

private boolean printAny(MessageOrBuilder message,
 TextFormat.TextGenerator generator)
                  throws 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:

IOException

printFieldToString

public String printFieldToString(Descriptors.FieldDescriptor field,
 Object value)

printField

public void printField(Descriptors.FieldDescriptor field,
 Object value,
 Appendable output)
                throws IOException

Throws:

IOException

printField

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

Throws:

IOException

printFieldValue

public void printFieldValue(Descriptors.FieldDescriptor field,
 Object value,
 Appendable output)
                     throws 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:

ClassCastException - if the value is not appropriate for the given field descriptor

IOException - if there is an exception writing to the output

printFieldValue

private void printFieldValue(Descriptors.FieldDescriptor field,
 Object value,
 TextFormat.TextGenerator generator)
                      throws IOException

Throws:

IOException

shouldRedactOptionValue

private boolean shouldRedactOptionValue(Descriptors.EnumValueDescriptor optionValue)

shouldRedact

private boolean shouldRedact(Descriptors.FieldDescriptor field)

printToString

public String printToString(MessageOrBuilder message)

Like print(), but writes directly to a String and returns it.

printToString

public String printToString(UnknownFieldSet fields)

Like print(), but writes directly to a String and returns it.

shortDebugString

@Deprecated
@InlineMe(replacement="this.emittingSingleLine(true).printToString(message)")
public 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 String shortDebugString(Descriptors.FieldDescriptor field,
 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 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,
 Object value,
 TextFormat.TextGenerator generator,
 boolean redact)
                                    throws IOException

Throws:

IOException

printMessage

private void printMessage(MessageOrBuilder message,
 TextFormat.TextGenerator generator)
                   throws IOException

Throws:

IOException

printSingleField

private void printSingleField(Descriptors.FieldDescriptor field,
 Object value,
 TextFormat.TextGenerator generator)
                       throws IOException

Throws:

IOException

printUnknownFields

private static void printUnknownFields(UnknownFieldSet unknownFields,
 TextFormat.TextGenerator generator,
 boolean redact)
                                throws IOException

Throws:

IOException

printUnknownField

private static void printUnknownField(int number,
 int wireType,
 List<?> values,
 TextFormat.TextGenerator generator,
 boolean redact)
                               throws IOException

Throws:

IOException