com.google.template.soy.data.restricted

Class NumberData

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyData

com.google.template.soy.data.restricted.PrimitiveData

com.google.template.soy.data.restricted.NumberData

All Implemented Interfaces:

SoyValue, SoyValueProvider

Direct Known Subclasses:

FloatData, IntegerData

public abstract class NumberData
extends PrimitiveData

Abstract superclass for number data (integers and floats).

Important: This class may only be used in implementing plugins (e.g. functions, directives).

Important: Even though this class is not marked 'final', do not extend this class.

Constructor Summary

Constructors

Constructor and Description
NumberData()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
int	hashCode()
double	numberValue() Precondition: Only call this method if you know that this SoyValue object is a number.
abstract double	toFloat() Gets the float value of this number data object.

Methods inherited from class com.google.template.soy.data.restricted.PrimitiveData

render

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

createFromExistingData

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

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

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

coerceToBoolean, coerceToString

Constructor Detail

NumberData

public NumberData()

Method Detail

toFloat

public abstract double toFloat()

Gets the float value of this number data object. If this object is actually an integer, its value will be converted to a float before being returned.

Returns:

The float value of this number data 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

Overrides:

numberValue in class SoyAbstractValue

Returns:

The float value of this number object.

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