com.google.template.soy.types

Class SoyProtoType

java.lang.Object

com.google.template.soy.types.SoyProtoType

All Implemented Interfaces:

SoyType

public final class SoyProtoType
extends Object
implements SoyType

A SoyType subclass which describes a protocol buffer type.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType

SoyType.Kind

Constructor Summary

Constructors

Constructor and Description
SoyProtoType(SoyTypeRegistry typeRegistry, com.google.protobuf.Descriptors.Descriptor descriptor, Set<com.google.protobuf.Descriptors.FieldDescriptor> extensions)

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDescriptorExpression() For ParseInfo generation, return a string that represents the Java source expression for the static descriptor constant.
com.google.protobuf.Descriptors.FieldDescriptor	getFieldDescriptor(String fieldName) Returns the Descriptors.FieldDescriptor of the given field.
com.google.common.collect.ImmutableSet<String>	getFieldNames() Returns all the field names of this proto.
SoyType	getFieldType(String fieldName) Returns the SoyType of the given field, or null if the field does not exist.
SoyType.Kind	getKind() Returns what kind of type this is.
String	getNameForBackend(SoyBackendKind backend) Returns this proto's type name for the given backend.
boolean	isAssignableFrom(SoyType fromType) Returns true if a parameter or field of this type can be assigned from a value of srcType.
boolean	shouldCheckFieldPresenceToEmulateJspbNullability(String fieldName) Whether or not server side emuluation of jspb semantics needs to check for field presence and return null for absent fields.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SoyProtoType

public SoyProtoType(SoyTypeRegistry typeRegistry,
                    com.google.protobuf.Descriptors.Descriptor descriptor,
                    Set<com.google.protobuf.Descriptors.FieldDescriptor> extensions)

Method Detail

getKind

public SoyType.Kind getKind()

Description copied from interface: SoyType

Returns what kind of type this is.

Specified by:

getKind in interface SoyType

isAssignableFrom

public boolean isAssignableFrom(SoyType fromType)

Description copied from interface: SoyType

Returns true if a parameter or field of this type can be assigned from a value of srcType.

Specified by:

isAssignableFrom in interface SoyType

Parameters:

fromType - The type of the incoming value.

Returns:

True if the assignment is valid.

getDescriptor

public com.google.protobuf.Descriptors.Descriptor getDescriptor()

getDescriptorExpression

public String getDescriptorExpression()

For ParseInfo generation, return a string that represents the Java source expression for the static descriptor constant.

Returns:

The Java source expression for this type's descriptor.

getFieldDescriptor

public com.google.protobuf.Descriptors.FieldDescriptor getFieldDescriptor(String fieldName)

Returns the Descriptors.FieldDescriptor of the given field.

getFieldType

@Nullable
public SoyType getFieldType(String fieldName)

Returns the SoyType of the given field, or null if the field does not exist.

getFieldNames

public com.google.common.collect.ImmutableSet<String> getFieldNames()

Returns all the field names of this proto.

getNameForBackend

public String getNameForBackend(SoyBackendKind backend)

Returns this proto's type name for the given backend.

toString

public String toString()

Overrides:

toString in class Object

shouldCheckFieldPresenceToEmulateJspbNullability

public boolean shouldCheckFieldPresenceToEmulateJspbNullability(String fieldName)

Whether or not server side emuluation of jspb semantics needs to check for field presence and return null for absent fields.

This isn't necessary in the JS backends because we can rely on the proto->JS compiler to create these semantics.