Package com.google.protobuf

Class TextFormat

java.lang.Object

com.google.protobuf.TextFormat

public final class TextFormat
extends Object

Provide text parsing and formatting support for proto2 instances. The implementation largely follows text_format.cc.

Author:

wenboz@google.com Wenbo Zhu, kenton@google.com Kenton Varda

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextFormat.InvalidEscapeSequenceException	Thrown by unescapeBytes(java.lang.CharSequence) and unescapeText(java.lang.String) when an invalid escape sequence is seen.
static class	TextFormat.ParseException	Thrown when parsing an invalid text format message.
static class	TextFormat.Parser	Parser for text-format proto2 instances.
static class	TextFormat.Printer	Helper class for converting protobufs to text.
static class	TextFormat.UnknownFieldParseException	Thrown when encountering an unknown field while parsing a text format message.

Method Summary

Modifier and Type	Method	Description
static String	escapeBytes(byte[] input)	Like escapeBytes(ByteString), but used for byte array.
static String	escapeBytes(ByteString input)	Escapes bytes in the format used in protocol buffer text format, which is the same as the format used for C string literals.
static String	escapeDoubleQuotesAndBackslashes(String input)	Escape double quotes and backslashes in a String for emittingUnicode output of a message.
static TextFormat.Parser	getParser()	Return a TextFormat.Parser instance which can parse text-format messages.
static void	merge(CharSequence input, ExtensionRegistry extensionRegistry, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
static void	merge(CharSequence input, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
static void	merge(Readable input, ExtensionRegistry extensionRegistry, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
static void	merge(Readable input, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
static <T extends Message> T	parse(CharSequence input, ExtensionRegistry extensionRegistry, Class<T> protoClass)	Parse a text-format message from input.
static <T extends Message> T	parse(CharSequence input, Class<T> protoClass)	Parse a text-format message from input.
static void	print(MessageOrBuilder message, Appendable output)	Deprecated. Use printer().print(MessageOrBuilder, Appendable)
static void	print(UnknownFieldSet fields, Appendable output)	Deprecated. Use printer().print(UnknownFieldSet, Appendable)
static TextFormat.Printer	printer()	Printer instance which escapes non-ASCII characters.
static void	printField(Descriptors.FieldDescriptor field, Object value, Appendable output)	Deprecated. Use printer().printField(FieldDescriptor, Object, Appendable)
static String	printFieldToString(Descriptors.FieldDescriptor field, Object value)	Deprecated. Use printer().printFieldToString(FieldDescriptor, Object)
static void	printFieldValue(Descriptors.FieldDescriptor field, Object value, Appendable output)	Deprecated. Use printer().printFieldValue(FieldDescriptor, Object, Appendable)
static String	printToString(MessageOrBuilder message)	Deprecated. Use message.toString()
static String	printToString(UnknownFieldSet fields)	Deprecated. Use UnknownFieldSet.toString()
static String	printToUnicodeString(MessageOrBuilder message)	Deprecated. Use printer().escapingNonAscii(false).printToString(MessageOrBuilder)
static String	printToUnicodeString(UnknownFieldSet fields)	Deprecated. Use printer().escapingNonAscii(false).printToString(UnknownFieldSet)
static void	printUnicode(MessageOrBuilder message, Appendable output)	Deprecated. Use printer().escapingNonAscii(false).print(MessageOrBuilder, Appendable)
static void	printUnicode(UnknownFieldSet fields, Appendable output)	Deprecated. Use printer().escapingNonAscii(false).print(UnknownFieldSet, Appendable)
static void	printUnicodeFieldValue(Descriptors.FieldDescriptor field, Object value, Appendable output)	Deprecated. Use printer().escapingNonAscii(false).printFieldValue(FieldDescriptor, Object, Appendable)
static void	printUnknownFieldValue(int tag, Object value, Appendable output)	Outputs a textual representation of the value of an unknown field.
static String	shortDebugString(Descriptors.FieldDescriptor field, Object value)	Deprecated. Use printer().shortDebugString(FieldDescriptor, Object)
static String	shortDebugString(MessageOrBuilder message)	Generates a human readable form of this message, useful for debugging and other purposes, with no newline characters.
static String	shortDebugString(UnknownFieldSet fields)	Deprecated. Use printer().shortDebugString(UnknownFieldSet)
static ByteString	unescapeBytes(CharSequence charString)	Un-escape a byte sequence as escaped using escapeBytes(ByteString).
static String	unsignedToString(int value)	Convert an unsigned 32-bit integer to a string.
static String	unsignedToString(long value)	Convert an unsigned 64-bit integer to a string.

Methods inherited from class java.lang.Object

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

Method Detail

print

@Deprecated
@InlineMe(replacement="TextFormat.printer().print(message, output)",
          imports="com.google.protobuf.TextFormat")
public static void print(MessageOrBuilder message,
                         Appendable output)
                  throws IOException

Deprecated.

Use printer().print(MessageOrBuilder, Appendable)

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

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

Deprecated.

Use printer().print(UnknownFieldSet, Appendable)

Outputs a textual representation of fields to output.

Throws:

IOException

printUnicode

@Deprecated
@InlineMe(replacement="TextFormat.printer().escapingNonAscii(false).print(message, output)",
          imports="com.google.protobuf.TextFormat")
public static void printUnicode(MessageOrBuilder message,
                                Appendable output)
                         throws IOException

Deprecated.

Use printer().escapingNonAscii(false).print(MessageOrBuilder, Appendable)

Same as print(), except that non-ASCII characters are not escaped.

Throws:

IOException

printUnicode

@Deprecated
public static void printUnicode(UnknownFieldSet fields,
                                Appendable output)
                         throws IOException

Deprecated.

Use printer().escapingNonAscii(false).print(UnknownFieldSet, Appendable)

Same as print(), except that non-ASCII characters are not escaped.

Throws:

IOException

shortDebugString

public static String shortDebugString(MessageOrBuilder message)

Generates a human readable form of this message, useful for debugging and other purposes, with no newline characters. This is just a trivial wrapper around TextFormat.Printer.shortDebugString(MessageOrBuilder).

shortDebugString

@Deprecated
public static String shortDebugString(Descriptors.FieldDescriptor field,
                                      Object value)

Deprecated.

Use printer().shortDebugString(FieldDescriptor, Object)

Generates a human readable form of the field, useful for debugging and other purposes, with no newline characters.

shortDebugString

@Deprecated
public static String shortDebugString(UnknownFieldSet fields)

Deprecated.

Use printer().shortDebugString(UnknownFieldSet)

Generates a human readable form of the unknown fields, useful for debugging and other purposes, with no newline characters.

printToString

@Deprecated
@InlineMe(replacement="TextFormat.printer().printToString(message)",
          imports="com.google.protobuf.TextFormat")
public static String printToString(MessageOrBuilder message)

Deprecated.

Use message.toString()

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

printToString

@Deprecated
public static String printToString(UnknownFieldSet fields)

Deprecated.

Use UnknownFieldSet.toString()

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

printToUnicodeString

@Deprecated
@InlineMe(replacement="TextFormat.printer().escapingNonAscii(false).printToString(message)",
          imports="com.google.protobuf.TextFormat")
public static String printToUnicodeString(MessageOrBuilder message)

Deprecated.

Use printer().escapingNonAscii(false).printToString(MessageOrBuilder)

Same as printToString(), except that non-ASCII characters in string type fields are not escaped in backslash+octals.

printToUnicodeString

@Deprecated
public static String printToUnicodeString(UnknownFieldSet fields)

Deprecated.

Use printer().escapingNonAscii(false).printToString(UnknownFieldSet)

Same as printToString(), except that non-ASCII characters in string type fields are not escaped in backslash+octals.

printField

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

Deprecated.

Use printer().printField(FieldDescriptor, Object, Appendable)

Throws:

IOException

printFieldToString

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

Deprecated.

Use printer().printFieldToString(FieldDescriptor, Object)

printUnicodeFieldValue

@Deprecated
public static void printUnicodeFieldValue(Descriptors.FieldDescriptor field,
                                          Object value,
                                          Appendable output)
                                   throws IOException

Deprecated.

Use printer().escapingNonAscii(false).printFieldValue(FieldDescriptor, Object, Appendable)

Outputs a unicode textual representation of the value of given field value.

Same as printFieldValue(), except that non-ASCII characters in string type fields are not escaped in backslash+octals.

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

@Deprecated
@InlineMe(replacement="TextFormat.printer().printFieldValue(field, value, output)",
          imports="com.google.protobuf.TextFormat")
public static void printFieldValue(Descriptors.FieldDescriptor field,
                                   Object value,
                                   Appendable output)
                            throws IOException

Deprecated.

Use printer().printFieldValue(FieldDescriptor, Object, Appendable)

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

printUnknownFieldValue

public static void printUnknownFieldValue(int tag,
                                          Object value,
                                          Appendable output)
                                   throws IOException

Outputs a textual representation of the value of an unknown field.

Parameters:

tag - the field's tag number

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

printer

public static TextFormat.Printer printer()

Printer instance which escapes non-ASCII characters.

unsignedToString

public static String unsignedToString(int value)

Convert an unsigned 32-bit integer to a string.

unsignedToString

public static String unsignedToString(long value)

Convert an unsigned 64-bit integer to a string.

getParser

public static TextFormat.Parser getParser()

Return a TextFormat.Parser instance which can parse text-format messages. The returned instance is thread-safe.

merge

public static void merge(Readable input,
                         Message.Builder builder)
                  throws IOException

Parse a text-format message from input and merge the contents into builder.

Throws:

IOException

merge

public static void merge(CharSequence input,
                         Message.Builder builder)
                  throws TextFormat.ParseException

Parse a text-format message from input and merge the contents into builder.

Throws:

TextFormat.ParseException

parse

public static <T extends Message> T parse(CharSequence input,
                                          Class<T> protoClass)
                                   throws TextFormat.ParseException

Parse a text-format message from input.

Returns:

the parsed message, guaranteed initialized

Throws:

TextFormat.ParseException

merge

public static void merge(Readable input,
                         ExtensionRegistry extensionRegistry,
                         Message.Builder builder)
                  throws IOException

Parse a text-format message from input and merge the contents into builder. Extensions will be recognized if they are registered in extensionRegistry.

Throws:

IOException

merge

public static void merge(CharSequence input,
                         ExtensionRegistry extensionRegistry,
                         Message.Builder builder)
                  throws TextFormat.ParseException

Parse a text-format message from input and merge the contents into builder. Extensions will be recognized if they are registered in extensionRegistry.

Throws:

TextFormat.ParseException

parse

public static <T extends Message> T parse(CharSequence input,
                                          ExtensionRegistry extensionRegistry,
                                          Class<T> protoClass)
                                   throws TextFormat.ParseException

Parse a text-format message from input. Extensions will be recognized if they are registered in extensionRegistry.

Returns:

the parsed message, guaranteed initialized

Throws:

TextFormat.ParseException

escapeBytes

public static String escapeBytes(ByteString input)

Escapes bytes in the format used in protocol buffer text format, which is the same as the format used for C string literals. All bytes that are not printable 7-bit ASCII characters are escaped, as well as backslash, single-quote, and double-quote characters. Characters for which no defined short-hand escape sequence is defined will be escaped using 3-digit octal sequences.

escapeBytes

public static String escapeBytes(byte[] input)

Like escapeBytes(ByteString), but used for byte array.

unescapeBytes

public static ByteString unescapeBytes(CharSequence charString)
                                throws TextFormat.InvalidEscapeSequenceException

Un-escape a byte sequence as escaped using escapeBytes(ByteString). Two-digit hex escapes (starting with "\x") are also recognized.

Throws:

TextFormat.InvalidEscapeSequenceException

escapeDoubleQuotesAndBackslashes

public static String escapeDoubleQuotesAndBackslashes(String input)

Escape double quotes and backslashes in a String for emittingUnicode output of a message.