SoyProtoValue (Closure Templates)

java.lang.Object
- com.google.template.soy.data.SoyAbstractValue
- - com.google.template.soy.data.SoyAbstractRecord
  - - com.google.template.soy.data.SoyAbstractCachingRecord
    - - com.google.template.soy.types.proto.SoyProtoValue

All Implemented Interfaces:

SoyMap, SoyRecord, SoyValue, SoyValueProvider, SoyProtoTypeImpl.Value
```
public final class SoyProtoValue
extends SoyAbstractCachingRecord
implements SoyProtoTypeImpl.Value, SoyMap
```
Soy value that wraps a protocol buffer message object.
This also implements SoyMap to deal with some uses that require "reflecting" over Soy proto fields. However, this usage is deprecated and will be unsupported when static type checking is used, since it doesn't work with Javascript, which does not support reflection.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`coerceToBoolean()` Coerces this value into a boolean.
`String`	`coerceToString()` Coerces this value into a string.
`boolean`	`equals(Object other)` Compares this value against another for equality in the sense of the '==' operator of Soy.
`SoyValueProvider`	`getFieldProviderInternal(String name)` Gets a provider of a field value of this SoyRecord.
`SoyValue`	`getItem(SoyValue key)` Gets an item value of this SoyMap.
`int`	`getItemCnt()` Gets the number of items in this SoyMap.
`Collection<SoyValue>`	`getItemKeys()` Gets an iterable over all item keys in this SoyMap.
`SoyValueProvider`	`getItemProvider(SoyValue key)` Gets a provider of an item value of this SoyMap.
`com.google.protobuf.Message`	`getProto()` Returns the underlying message.
`boolean`	`hasField(String name)` Checks whether this SoyRecord has a field of the given name.
`int`	`hashCode()`
`boolean`	`hasItem(SoyValue key)` Checks whether this SoyMap has an item with the given key.
`void`	`render(Appendable appendable)` Renders this value to the given appendable.
`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.SoyAbstractCachingRecord
getFieldProvider

Methods inherited from class com.google.template.soy.data.SoyAbstractRecord
getField

Methods inherited from class com.google.template.soy.data.SoyAbstractValue
booleanValue, floatValue, integerValue, longValue, numberValue, 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.SoyRecord
getField, getFieldProvider

Methods inherited from interface com.google.template.soy.data.SoyValue
booleanValue, floatValue, integerValue, longValue, numberValue, stringValue

Methods inherited from interface com.google.template.soy.data.SoyValueProvider
renderAndResolve, resolve, status

- Method Detail
  - hasField
```
public boolean hasField(String name)
```
    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.
  - getFieldProviderInternal
```
public SoyValueProvider getFieldProviderInternal(String name)
```
    Description copied from class: SoyAbstractCachingRecord
    
    Gets a provider of a field value of this SoyRecord.
    
    Specified by:
    
    getFieldProviderInternal in class SoyAbstractCachingRecord
    
    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.
  - hasItem
```
public boolean hasItem(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Checks whether this SoyMap has an item with the given key.
    
    Specified by:
    
    hasItem in interface SoyMap
    
    Parameters:
    key - The item key to check.
    
    Returns:
    Whether this SoyMap has an item with the given key.
  - getItemProvider
```
public SoyValueProvider getItemProvider(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Gets a provider of an item value of this SoyMap.
    
    Specified by:
    
    getItemProvider in interface SoyMap
    
    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.
  - getItem
```
public SoyValue getItem(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Gets an item value of this SoyMap.
    
    Specified by:
    
    getItem in interface SoyMap
    
    Parameters:
    key - The item key to get.
    
    Returns:
    The item value for the given item key, or null if no such item key.
  - getItemKeys
```
public Collection<SoyValue> getItemKeys()
```
    Description copied from interface: SoyMap
    
    Gets an iterable over all item keys in this SoyMap. Important: Iteration order is undefined.
    
    Specified by:
    
    getItemKeys in interface SoyMap
    
    Returns:
    An iterable over all item keys.
  - getItemCnt
```
public int getItemCnt()
```
    Description copied from interface: SoyMap
    
    Gets the number of items in this SoyMap.
    
    Specified by:
    
    getItemCnt in interface SoyMap
    
    Returns:
    The number of items.
  - 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.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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.
  - render
```
public void render(Appendable 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
  - 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.
  - getProto
```
public com.google.protobuf.Message getProto()
```
    Returns the underlying message.
    
    Specified by:
    
    getProto in interface SoyProtoTypeImpl.Value
  - 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

Class SoyProtoValue

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Method Detail

hasField

getFieldProviderInternal

hasItem

getItemProvider

getItem

getItemKeys

getItemCnt

equals

hashCode

coerceToBoolean

render

coerceToString

getProto

toString