com.google.template.soy.data

Class SoyProtoValueImpl

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyProtoValueImpl

All Implemented Interfaces:

SoyLegacyObjectMap, SoyProtoValue, SoyRecord, SoyValue, SoyValueProvider

public final class SoyProtoValueImpl
extends SoyAbstractValue
implements SoyProtoValue, SoyLegacyObjectMap, SoyRecord

Soy value that wraps a protocol buffer message object.

TODO(b/70906867): This implements SoyMap/SoyRecord for backwards compatibility. When Soy initially added support for protos we implemented these interfaces to support using protos in legacy untyped templates. This made it easier for teams to start passing protos to their templates but has turned out to be a bad idea because it means your templates work differently in javascript vs java. So now we continue to support these usecases but issue warnings when it occurs. In the long run we will switch to either throwing exception or always returning null from these methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyProtoValueImpl.Builder Provides an interface for constructing a SoyProtoValueImpl.

Method Summary

Modifier and Type	Method and Description
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
static SoyProtoValueImpl	create(com.google.protobuf.Message proto)
boolean	equals(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
SoyValue	getField(String name) Deprecated.
SoyValueProvider	getFieldProvider(String name) Deprecated.
SoyValue	getItem(SoyValue key) Deprecated.
int	getItemCnt() Deprecated.
Collection<SoyValue>	getItemKeys() Deprecated.
SoyValueProvider	getItemProvider(SoyValue key) Deprecated.
com.google.protobuf.Message	getProto() Returns the underlying message.
SoyValue	getProtoField(String name) Gets a value for the field for the underlying proto object.
boolean	hasField(String name) Deprecated.
int	hashCode()
boolean	hasItem(SoyValue key) Deprecated.
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.
void	setAccessLocationKey(Object location)
String	toString() Returns a string that indicates the type of proto held, to assist in debugging Soy type errors.

Methods inherited from class com.google.template.soy.data.SoyAbstractValue

booleanValue, floatValue, integerValue, longValue, numberValue, render, renderAndResolve, resolve, status, stringValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.data.SoyValue

booleanValue, floatValue, integerValue, longValue, numberValue, render, stringValue

Methods inherited from interface com.google.template.soy.data.SoyValueProvider

renderAndResolve, resolve, status

Method Detail

create

public static SoyProtoValueImpl create(com.google.protobuf.Message proto)

getProto

public com.google.protobuf.Message getProto()

Returns the underlying message.

Specified by:

getProto in interface SoyProtoValue

getProtoField

public SoyValue getProtoField(String name)

Description copied from interface: SoyProtoValue

Gets a value for the field for the underlying proto object. Not intended for general use.

Specified by:

getProtoField in interface SoyProtoValue

Parameters:

name - The proto field name.

Returns:

The value of the given field for the underlying proto object, or NullData if either the field does not exist or the value is not set in the underlying proto (according to the jspb semantics)

setAccessLocationKey

public void setAccessLocationKey(Object location)

hasField

@Deprecated
public boolean hasField(String name)

Deprecated.

Description copied from interface: SoyRecord

Checks whether this SoyRecord has a field of the given name.

Specified by:

hasField in interface SoyRecord

Parameters:

name - The field name to check.

Returns:

Whether this SoyRecord has a field of the given name.

getField

@Deprecated
public SoyValue getField(String name)

Deprecated.

Description copied from interface: SoyRecord

Gets a field value of this SoyRecord.

Specified by:

getField in interface SoyRecord

Parameters:

name - The field name to get.

Returns:

The field value for the given field name, or null if no such field name.

getFieldProvider

@Deprecated
public SoyValueProvider getFieldProvider(String name)

Deprecated.

Description copied from interface: SoyRecord

Gets a provider of a field value of this SoyRecord.

Specified by:

getFieldProvider in interface SoyRecord

Parameters:

name - The field name to get.

Returns:

A provider of the field value for the given field name, or null if no such field name.

getItemCnt

@Deprecated
public int getItemCnt()

Deprecated.

Description copied from interface: SoyLegacyObjectMap

Gets the number of items in this SoyMap.

Specified by:

getItemCnt in interface SoyLegacyObjectMap

Returns:

The number of items.

getItemKeys

@Deprecated
public Collection<SoyValue> getItemKeys()

Deprecated.

Description copied from interface: SoyLegacyObjectMap

Gets an iterable over all item keys in this SoyMap.

Important: Iteration order is undefined.

Specified by:

getItemKeys in interface SoyLegacyObjectMap

Returns:

An iterable over all item keys.

hasItem

@Deprecated
public boolean hasItem(SoyValue key)

Deprecated.

Description copied from interface: SoyLegacyObjectMap

Checks whether this SoyMap has an item with the given key.

Specified by:

hasItem in interface SoyLegacyObjectMap

Parameters:

key - The item key to check.

Returns:

Whether this SoyMap has an item with the given key.

getItem

@Deprecated
public SoyValue getItem(SoyValue key)

Deprecated.

Description copied from interface: SoyLegacyObjectMap

Gets an item value of this SoyMap.

Specified by:

getItem in interface SoyLegacyObjectMap

Parameters:

key - The item key to get.

Returns:

The item value for the given item key, or null if no such item key.

getItemProvider

@Deprecated
public SoyValueProvider getItemProvider(SoyValue key)

Deprecated.

Description copied from interface: SoyLegacyObjectMap

Gets a provider of an item value of this SoyMap.

Specified by:

getItemProvider in interface SoyLegacyObjectMap

Parameters:

key - The item key to get.

Returns:

A provider of the item value for the given item key, or null if no such item key.

equals

public boolean equals(Object other)

Description copied from interface: SoyValue

Compares this value against another for equality in the sense of the '==' operator of Soy.

Specified by:

equals in interface SoyValue

Specified by:

equals in class SoyAbstractValue

Parameters:

other - The other value to compare against.

Returns:

True if this value is equal to the other in the sense of Soy.

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

Specified by:

coerceToBoolean in interface SoyValue

Returns:

This value coerced into a boolean.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Specified by:

coerceToString in interface SoyValue

Returns:

This value coerced into a string.

render

public void render(LoggingAdvisingAppendable appendable)
            throws IOException

Description copied from interface: SoyValue

Renders this value to the given appendable.

This should behave identically to appendable.append(coerceToString()) but is provided separately to allow more incremental approaches.

Specified by:

render in interface SoyValue

Parameters:

appendable - The appendable to render to.

Throws:

IOException

toString

public String toString()

Returns a string that indicates the type of proto held, to assist in debugging Soy type errors.

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object