com.google.template.soy.data

Class SoyAbstractValue

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

All Implemented Interfaces:

SoyValue, SoyValueProvider

Direct Known Subclasses:

SoyAbstractList, SoyAbstractMap, SoyAbstractRecord, SoyData

@ParametersAreNonnullByDefault
public abstract class SoyAbstractValue
extends Object
implements SoyValue

Abstract implementation of SoyValue.

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
SoyAbstractValue()

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue() Precondition: Only call this method if you know that this SoyValue object is a boolean.
boolean	equals(SoyValueProvider other) Note: Even though we provide a default implementation for equals(SoyValueProvider), subclasses must still implement equals(SoyValue).
double	floatValue() Precondition: Only call this method if you know that this SoyValue object is a float.
int	integerValue() Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer.
long	longValue() Precondition: Only call this method if you know that this SoyValue object is an integer or long.
double	numberValue() Precondition: Only call this method if you know that this SoyValue object is a number.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.
String	stringValue() Precondition: Only call this method if you know that this SoyValue object is a string.

Methods inherited from class java.lang.Object

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

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

coerceToBoolean, coerceToString, equals, render

Constructor Detail

SoyAbstractValue

public SoyAbstractValue()

Method Detail

resolve

@Nonnull
public 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)

Note: Even though we provide a default implementation for equals(SoyValueProvider), subclasses must still implement equals(SoyValue). 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.

booleanValue

public boolean booleanValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a boolean. This method gets the boolean value of this boolean object.

Specified by:

booleanValue in interface SoyValue

Returns:

The boolean value of this boolean object.

integerValue

public int integerValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer. This method gets the integer value of this integer object.

Specified by:

integerValue in interface SoyValue

Returns:

The integer value of this integer object.

longValue

public long longValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is an integer or long. This method gets the integer value of this integer object.

Specified by:

longValue in interface SoyValue

Returns:

The integer value of this integer object.

floatValue

public double floatValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a float. This method gets the float value of this float object.

Specified by:

floatValue in interface SoyValue

Returns:

The float value of this float object.

numberValue

public double numberValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a number. This method gets the float value of this number object (converting integer to float if necessary).

Specified by:

numberValue in interface SoyValue

Returns:

The float value of this number object.

stringValue

public String stringValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a string. This method gets the string value of this string object.

Specified by:

stringValue in interface SoyValue

Returns:

The string value of this string object.