SoyAbstractList (Closure Templates)

java.lang.Object
- com.google.template.soy.data.SoyAbstractValue
- - com.google.template.soy.data.SoyAbstractList

All Implemented Interfaces:

SoyList, SoyMap, SoyValue, SoyValueProvider

Direct Known Subclasses:

EasyListImpl, ListImpl
```
@ParametersAreNonnullByDefault
public abstract class SoyAbstractList
extends SoyAbstractValue
implements SoyList
```
Abstract implementation of SoyList.
Important: Until this API is more stable and this note is removed, users must not define classes that extend this class.

Constructor Summary

Constructors
Constructor and Description

SoyAbstractList()

Constructors
Constructor and Description
`SoyAbstractList()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`coerceToBoolean()` This implementation is always truthy (to match JS behavior).
`String`	`coerceToString()` Coerces this value into a string.
`boolean`	`equals(Object other)` This implementation uses object identity (to match JS behavior).
`SoyValue`	`get(int index)` Gets a value of this SoyList.
`protected int`	`getIntegerIndex(SoyValue key)` Gets the integer index out of a SoyValue key, or throws SoyDataException if the key is not an integer.
`SoyValue`	`getItem(SoyValue key)` Gets an item value of this SoyMap.
`int`	`getItemCnt()` Gets the number of items in this SoyMap.
`Iterable<IntegerData>`	`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.
`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.

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, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.template.soy.data.SoyList
asJavaList, asResolvedJavaList, getProvider, length

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

- Constructor Detail
  - SoyAbstractList
```
public SoyAbstractList()
```
- Method Detail
  - get
```
public final SoyValue get(int index)
```
    Description copied from interface: SoyList
    
    Gets a value of this SoyList.
    
    Specified by:
    
    get in interface SoyList
    
    Parameters:
    index - The index to get.
    
    Returns:
    The value for the given index, or null if no such index.
  - getItemCnt
```
public final 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.
  - getItemKeys
```
@Nonnull
public final Iterable<IntegerData> 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.
  - hasItem
```
public final 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.
  - getItem
```
public final 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.
  - getItemProvider
```
public final 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.
  - getIntegerIndex
```
protected final int getIntegerIndex(SoyValue key)
```
    Gets the integer index out of a SoyValue key, or throws SoyDataException if the key is not an integer.
    
    Parameters:
    key - The SoyValue key.
    
    Returns:
    The index.
  - coerceToString
```
public final 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(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
  - equals
```
public final boolean equals(Object other)
```
    This implementation uses object identity (to match JS behavior). Note: Users will eventually be able to create their own implementations if they desire.
    
    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 final boolean coerceToBoolean()
```
    This implementation is always truthy (to match JS behavior). Note: Users will eventually be able to create their own implementations if they desire.
    
    Specified by:
    
    coerceToBoolean in interface SoyValue
    
    Returns:
    This value coerced into a boolean.

Class SoyAbstractList

Constructor Summary

Method Summary

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.SoyList

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

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

Constructor Detail

SoyAbstractList

Method Detail

get

getItemCnt

getItemKeys

hasItem

getItem

getItemProvider

getIntegerIndex

coerceToString

render

equals

coerceToBoolean