Package com.google.protobuf

Class TextFormat.Parser

java.lang.Object

com.google.protobuf.TextFormat.Parser

Enclosing class:

TextFormat

public static class TextFormat.Parser
extends Object

Parser for text-format proto2 instances. This class is thread-safe. The implementation largely follows google/protobuf/text_format.cc.

Use TextFormat.getParser() to obtain the default parser, or TextFormat.Parser.Builder to control the parser behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextFormat.Parser.Builder	Builder that can be used to obtain new instances of TextFormat.Parser.
static enum	TextFormat.Parser.SingularOverwritePolicy	Determines if repeated values for non-repeated fields and oneofs are permitted.
(package private) static final class	TextFormat.Parser.UnknownField

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowUnknownEnumValues
private final boolean	allowUnknownExtensions
private final boolean	allowUnknownFields
private static final int	BUFFER_SIZE
private TextFormatParseInfoTree.Builder	parseInfoTreeBuilder
private final TextFormat.Parser.SingularOverwritePolicy	singularOverwritePolicy
private final TypeRegistry	typeRegistry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Parser(TypeRegistry typeRegistry, boolean allowUnknownFields, boolean allowUnknownEnumValues, boolean allowUnknownExtensions, TextFormat.Parser.SingularOverwritePolicy singularOverwritePolicy, TextFormatParseInfoTree.Builder parseInfoTreeBuilder)

Method Summary

Modifier and Type	Method	Description
private void	checkUnknownFields(List<TextFormat.Parser.UnknownField> unknownFields)
private void	consumeFieldValue(TextFormat.Tokenizer tokenizer, ExtensionRegistry extensionRegistry, MessageReflection.MergeTarget target, Descriptors.FieldDescriptor field, ExtensionRegistry.ExtensionInfo extension, TextFormatParseInfoTree.Builder parseTreeBuilder, List<TextFormat.Parser.UnknownField> unknownFields)	Parse a single field value from tokenizer and merge it into builder.
private void	consumeFieldValues(TextFormat.Tokenizer tokenizer, ExtensionRegistry extensionRegistry, MessageReflection.MergeTarget target, Descriptors.FieldDescriptor field, ExtensionRegistry.ExtensionInfo extension, TextFormatParseInfoTree.Builder parseTreeBuilder, List<TextFormat.Parser.UnknownField> unknownFields)	Parse a one or more field values from tokenizer and merge it into builder.
void	merge(CharSequence input, ExtensionRegistry extensionRegistry, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
void	merge(CharSequence input, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
void	merge(Readable input, ExtensionRegistry extensionRegistry, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
void	merge(Readable input, Message.Builder builder)	Parse a text-format message from input and merge the contents into builder.
private void	mergeAnyFieldValue(TextFormat.Tokenizer tokenizer, ExtensionRegistry extensionRegistry, MessageReflection.MergeTarget target, TextFormatParseInfoTree.Builder parseTreeBuilder, List<TextFormat.Parser.UnknownField> unknownFields, Descriptors.Descriptor anyDescriptor)
private void	mergeField(TextFormat.Tokenizer tokenizer, ExtensionRegistry extensionRegistry, MessageReflection.MergeTarget target, TextFormatParseInfoTree.Builder parseTreeBuilder, List<TextFormat.Parser.UnknownField> unknownFields)	Parse a single field from tokenizer and merge it into target.
private void	mergeField(TextFormat.Tokenizer tokenizer, ExtensionRegistry extensionRegistry, MessageReflection.MergeTarget target, List<TextFormat.Parser.UnknownField> unknownFields)	Parse a single field from tokenizer and merge it into builder.
static TextFormat.Parser.Builder	newBuilder()	Returns a new instance of TextFormat.Parser.Builder.
private static void	skipField(TextFormat.Tokenizer tokenizer)	Skips the next field including the field's name and value.
private static void	skipFieldMessage(TextFormat.Tokenizer tokenizer)	Skips the whole body of a message including the beginning delimiter and the ending delimiter.
private static void	skipFieldValue(TextFormat.Tokenizer tokenizer)	Skips a field value.
private static StringBuilder	toStringBuilder(Readable input)

Methods inherited from class java.lang.Object

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

Field Details

typeRegistry

private final TypeRegistry typeRegistry

allowUnknownFields

private final boolean allowUnknownFields

allowUnknownEnumValues

private final boolean allowUnknownEnumValues

allowUnknownExtensions

private final boolean allowUnknownExtensions

singularOverwritePolicy

private final TextFormat.Parser.SingularOverwritePolicy singularOverwritePolicy

parseInfoTreeBuilder

private TextFormatParseInfoTree.Builder parseInfoTreeBuilder

BUFFER_SIZE

private static final int BUFFER_SIZE

See Also:

• Constant Field Values

Constructor Details

Parser

private Parser(TypeRegistry typeRegistry,
 boolean allowUnknownFields,
 boolean allowUnknownEnumValues,
 boolean allowUnknownExtensions,
 TextFormat.Parser.SingularOverwritePolicy singularOverwritePolicy,
 TextFormatParseInfoTree.Builder parseInfoTreeBuilder)

Method Details

newBuilder

public static TextFormat.Parser.Builder newBuilder()

Returns a new instance of TextFormat.Parser.Builder.

merge

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

toStringBuilder

private static StringBuilder toStringBuilder(Readable input)
                                      throws IOException

Throws:

IOException

checkUnknownFields

private void checkUnknownFields(List<TextFormat.Parser.UnknownField> unknownFields)
                         throws TextFormat.ParseException

Throws:

TextFormat.ParseException

merge

public 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

mergeField

private void mergeField(TextFormat.Tokenizer tokenizer,
 ExtensionRegistry extensionRegistry,
 MessageReflection.MergeTarget target,
 List<TextFormat.Parser.UnknownField> unknownFields)
                 throws TextFormat.ParseException

Parse a single field from tokenizer and merge it into builder.

Throws:

TextFormat.ParseException

mergeField

private void mergeField(TextFormat.Tokenizer tokenizer,
 ExtensionRegistry extensionRegistry,
 MessageReflection.MergeTarget target,
 TextFormatParseInfoTree.Builder parseTreeBuilder,
 List<TextFormat.Parser.UnknownField> unknownFields)
                 throws TextFormat.ParseException

Parse a single field from tokenizer and merge it into target.

Throws:

TextFormat.ParseException

consumeFieldValues

private void consumeFieldValues(TextFormat.Tokenizer tokenizer,
 ExtensionRegistry extensionRegistry,
 MessageReflection.MergeTarget target,
 Descriptors.FieldDescriptor field,
 ExtensionRegistry.ExtensionInfo extension,
 TextFormatParseInfoTree.Builder parseTreeBuilder,
 List<TextFormat.Parser.UnknownField> unknownFields)
                         throws TextFormat.ParseException

Parse a one or more field values from tokenizer and merge it into builder.

Throws:

TextFormat.ParseException

consumeFieldValue

private void consumeFieldValue(TextFormat.Tokenizer tokenizer,
 ExtensionRegistry extensionRegistry,
 MessageReflection.MergeTarget target,
 Descriptors.FieldDescriptor field,
 ExtensionRegistry.ExtensionInfo extension,
 TextFormatParseInfoTree.Builder parseTreeBuilder,
 List<TextFormat.Parser.UnknownField> unknownFields)
                        throws TextFormat.ParseException

Parse a single field value from tokenizer and merge it into builder.

Throws:

TextFormat.ParseException

mergeAnyFieldValue

private void mergeAnyFieldValue(TextFormat.Tokenizer tokenizer,
 ExtensionRegistry extensionRegistry,
 MessageReflection.MergeTarget target,
 TextFormatParseInfoTree.Builder parseTreeBuilder,
 List<TextFormat.Parser.UnknownField> unknownFields,
 Descriptors.Descriptor anyDescriptor)
                         throws TextFormat.ParseException

Throws:

TextFormat.ParseException

skipField

private static void skipField(TextFormat.Tokenizer tokenizer)
                       throws TextFormat.ParseException

Skips the next field including the field's name and value.

Throws:

TextFormat.ParseException

skipFieldMessage

private static void skipFieldMessage(TextFormat.Tokenizer tokenizer)
                              throws TextFormat.ParseException

Skips the whole body of a message including the beginning delimiter and the ending delimiter.

Throws:

TextFormat.ParseException

skipFieldValue

private static void skipFieldValue(TextFormat.Tokenizer tokenizer)
                            throws TextFormat.ParseException

Skips a field value.

Throws:

TextFormat.ParseException