io.spine.js.generate.field

Class FieldToParse

java.lang.Object

io.spine.js.generate.field.FieldToParse

public final class FieldToParse
extends java.lang.Object

A Protobuf field, which is going to be parsed from a plain JavaScript object to a Protobuf-specific type.

The class contains the data required to generate code for parsing of a field, such as a field descriptor, names of variables involved in code for parsing.

Constructor Summary

Constructors

Constructor and Description
FieldToParse(com.google.protobuf.Descriptors.FieldDescriptor descriptor, java.lang.String objectVariable, java.lang.String messageVariable) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Descriptors.FieldDescriptor	descriptor() Obtains the descriptor of the field.
java.lang.String	messageVariable() Obtains the name of a variable to set the field at.
java.lang.String	value() Obtains the reference to the field value on the source object.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldToParse

public FieldToParse(com.google.protobuf.Descriptors.FieldDescriptor descriptor,
                    java.lang.String objectVariable,
                    java.lang.String messageVariable)

Creates a new instance.

Parameters:

descriptor - the descriptor of the field to be parsed

objectVariable - the name of the object to get the field value to be parsed

messageVariable - the name of the message to set the parsed field

Method Detail

descriptor

public com.google.protobuf.Descriptors.FieldDescriptor descriptor()

Obtains the descriptor of the field.

messageVariable

public java.lang.String messageVariable()

Obtains the name of a variable to set the field at.

value

public java.lang.String value()

Obtains the reference to the field value on the source object.