com.google.template.soy.data

Class SoyAbstractCachingValueProvider

java.lang.Object

com.google.template.soy.data.SoyAbstractCachingValueProvider

All Implemented Interfaces:

SoyValueProvider

Direct Known Subclasses:

SoyFutureValueProvider

public abstract class SoyAbstractCachingValueProvider
extends Object
implements SoyValueProvider

A SoyValueProvider that lazily computes and caches its value.

SoyAbstractCachingValueProvider is thread-safe, but in a race condition, may compute its value twice.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyAbstractCachingValueProvider.ValueAssertion A mechanism to plug in assertions on the computed value that will be run the first time the value is computed.

Nested classes/interfaces inherited from interface com.google.template.soy.data.SoyValueProvider

SoyValueProvider.ResolveStatus

Constructor Summary

Constructors

Constructor and Description
SoyAbstractCachingValueProvider()

Method Summary

Modifier and Type	Method and Description
void	addValueAssertion(SoyAbstractCachingValueProvider.ValueAssertion assertion) Registers a SoyAbstractCachingValueProvider.ValueAssertion callback with this caching provider.
protected abstract SoyValue	compute() Implemented by subclasses to do the heavy-lifting for resolving.
boolean	equals(Object other)
boolean	equals(SoyValueProvider other) Compares this value against another for equality for the purposes of Soy.
int	hashCode()
boolean	isComputed() Returns true if the caching provider has already been calculated.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.

Methods inherited from class java.lang.Object

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

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

status

Constructor Detail

SoyAbstractCachingValueProvider

public SoyAbstractCachingValueProvider()

Method Detail

resolve

public final SoyValue resolve()

Description copied from interface: SoyValueProvider

Usually, this method is a no-op that simply returns this object. However, if this value needs to be resolved at usage time, then this method resolves and returns the resolved value.

Specified by:

resolve in interface SoyValueProvider

Returns:

The resolved value.

equals

public boolean equals(SoyValueProvider other)

Description copied from interface: SoyValueProvider

Compares this value against another for equality for the purposes of Soy.

Specified by:

equals in interface SoyValueProvider

Parameters:

other - The other value to compare against.

Returns:

True if the two values are equal.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isComputed

public final boolean isComputed()

Returns true if the caching provider has already been calculated.

addValueAssertion

public void addValueAssertion(SoyAbstractCachingValueProvider.ValueAssertion assertion)

Registers a SoyAbstractCachingValueProvider.ValueAssertion callback with this caching provider.

compute

protected abstract SoyValue compute()

Implemented by subclasses to do the heavy-lifting for resolving.