Class TextFormatParseInfoTree

public class TextFormatParseInfoTree

Data structure which is populated with the locations of each field value parsed from the text.

The locations of primary fields values are retrieved by getLocation or getLocations. The locations of sub message values are within nested TextFormatParseInfoTrees and are retrieve by getNestedTree or getNestedTrees.

The TextFormatParseInfoTree is created by a Builder.

Inheritance

java.lang.Object > TextFormatParseInfoTree

Static Methods

builder()

public static TextFormatParseInfoTree.Builder builder()

Create a builder for a ParseInfoTree.

Returns
TypeDescription
TextFormatParseInfoTree.Builder

the builder

Methods

getLocation(Descriptors.FieldDescriptor fieldDescriptor, int index)

public TextFormatParseLocation getLocation(Descriptors.FieldDescriptor fieldDescriptor, int index)

Get the location in the source of a field's value.

Returns the TextFormatParseLocation for index-th value of the field in the parsed text.

Parameters
NameDescription
fieldDescriptorDescriptors.FieldDescriptor

the FieldDescriptor of the desired field

indexint

the index of the value.

Returns
TypeDescription
TextFormatParseLocation

the TextFormatParseLocation of the value

getLocations(Descriptors.FieldDescriptor fieldDescriptor)

public List<TextFormatParseLocation> getLocations(Descriptors.FieldDescriptor fieldDescriptor)

Retrieve all the locations of a field.

Parameter
NameDescription
fieldDescriptorDescriptors.FieldDescriptor

the FieldDescriptor of the desired field

Returns
TypeDescription
List<TextFormatParseLocation>

a list of the locations of values of the field. If there are not values or the field doesn't exist, an empty list is returned.

getNestedTree(Descriptors.FieldDescriptor fieldDescriptor, int index)

public TextFormatParseInfoTree getNestedTree(Descriptors.FieldDescriptor fieldDescriptor, int index)

Returns the parse info tree for the given field, which must be a message type.

Parameters
NameDescription
fieldDescriptorDescriptors.FieldDescriptor

the FieldDescriptor of the desired sub message

indexint

the index of message value.

Returns
TypeDescription
TextFormatParseInfoTree

the ParseInfoTree of the message value. null is returned if the field doesn't exist or the index is out of range.

getNestedTrees(Descriptors.FieldDescriptor fieldDescriptor)

public List<TextFormatParseInfoTree> getNestedTrees(Descriptors.FieldDescriptor fieldDescriptor)

Retrieve a list of all the location information trees for a sub message field.

Parameter
NameDescription
fieldDescriptorDescriptors.FieldDescriptor

the FieldDescriptor of the desired field

Returns
TypeDescription
List<TextFormatParseInfoTree>

A list of TextFormatParseInfoTree