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 google/protobuf/text_format.cc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`TextFormat.ParseException` Thrown when parsing an invalid text format message.
`static class`	`TextFormat.Parser` Parser for text-format proto2 instances.

Method Summary

Methods

Modifier and Type	Method and Description
`static String`	`escapeDoubleQuotesAndBackslashes(String input)` Escape double quotes and backslashes in a String for unicode output of a message.
`static TextFormat.Parser`	`getParser()` Return a `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 void`	`print(MessageOrBuilder message, Appendable output)` Outputs a textual representation of the Protocol Message supplied into the parameter output.
`static void`	`print(UnknownFieldSet fields, Appendable output)` Outputs a textual representation of `fields` to `output`.
`static void`	`printField(Descriptors.FieldDescriptor field, Object value, Appendable output)`
`static String`	`printFieldToString(Descriptors.FieldDescriptor field, Object value)`
`static void`	`printFieldValue(Descriptors.FieldDescriptor field, Object value, Appendable output)` Outputs a textual representation of the value of given field value.
`static String`	`printToString(MessageOrBuilder message)` Like `print()`, but writes directly to a `String` and returns it.
`static String`	`printToString(UnknownFieldSet fields)` Like `print()`, but writes directly to a `String` and returns it.
`static String`	`printToUnicodeString(MessageOrBuilder message)` Same as `printToString()`, except that non-ASCII characters in string type fields are not escaped in backslash+octals.
`static String`	`printToUnicodeString(UnknownFieldSet fields)` Same as `printToString()`, except that non-ASCII characters in string type fields are not escaped in backslash+octals.
`static void`	`printUnicode(MessageOrBuilder message, Appendable output)` Same as `print()`, except that non-ASCII characters are not escaped.
`static void`	`printUnicode(UnknownFieldSet fields, Appendable output)` Same as `print()`, except that non-ASCII characters are not escaped.
`static void`	`printUnknownFieldValue(int tag, Object value, Appendable output)` Outputs a textual representation of the value of an unknown field.
`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)` Generates a human readable form of the unknown fields, useful for debugging and other purposes, with no newline characters.
`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
```
public static 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 static void print(UnknownFieldSet fields,
                         Appendable output)
                  throws IOException

Outputs a textual representation of fields to output.

Throws:: IOException

printUnicode

public static void printUnicode(MessageOrBuilder message,
                                Appendable output)
                         throws IOException

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

Throws:: IOException

printUnicode

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

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.

shortDebugString
```
public static String shortDebugString(UnknownFieldSet fields)
```
Generates a human readable form of the unknown fields, useful for debugging and other purposes, with no newline characters.

printToString
```
public static String printToString(MessageOrBuilder message)
```
Like print(), but writes directly to a String and returns it.

printToString
```
public static String printToString(UnknownFieldSet fields)
```
Like print(), but writes directly to a String and returns it.

printToUnicodeString
```
public static String printToUnicodeString(MessageOrBuilder message)
```
Same as printToString(), except that non-ASCII characters in string type fields are not escaped in backslash+octals.

printToUnicodeString
```
public static String printToUnicodeString(UnknownFieldSet fields)
```
Same as printToString(), except that non-ASCII characters in string type fields are not escaped in backslash+octals.

printField

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

Throws:: IOException

printFieldToString

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

printFieldValue
```
public static 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

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

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 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

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

escapeDoubleQuotesAndBackslashes
```
public static String escapeDoubleQuotesAndBackslashes(String input)
```
Escape double quotes and backslashes in a String for unicode output of a message.

Class TextFormat

Nested Class Summary

Nested Classes

Method Summary

Methods

Methods inherited from class java.lang.Object

Method Detail

print

print

printUnicode

printUnicode

shortDebugString

shortDebugString

printToString

printToString

printToUnicodeString

printToUnicodeString

printField

printFieldToString

printFieldValue

printUnknownFieldValue

unsignedToString

unsignedToString

getParser

merge

merge

merge

merge

escapeDoubleQuotesAndBackslashes