com.google.template.soy.data.restricted

Class FloatData

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

com.google.template.soy.data.restricted.FloatData

All Implemented Interfaces:

SoyValue, SoyValueProvider

@Immutable
public final class FloatData
extends NumberData

Float data.

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

Constructor Summary

Constructors

Constructor and Description
FloatData(double value) Deprecated. Use forValue(double).

Method Summary

Modifier and Type	Method and Description
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
double	floatValue() Precondition: Only call this method if you know that this SoyValue object is a float.
static FloatData	forValue(double value) Gets a FloatData instance for the given value.
double	getValue() Returns the float value.
double	toFloat() Gets the float value of this number data object.
String	toString()
static String	toString(double value) Returns Soy's idea of a double as a string.

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

equals, hashCode, numberValue

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, integerValue, longValue, render, renderAndResolve, resolve, status, stringValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatData

@Deprecated
public FloatData(double value)

Deprecated. Use forValue(double).

Parameters:

value - The float value.

Method Detail

forValue

public static FloatData forValue(double value)

Gets a FloatData instance for the given value.

Parameters:

value - The desired value.

Returns:

A FloatData instance with the given value.

getValue

public double getValue()

Returns the float value.

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

Overrides:

floatValue in class SoyAbstractValue

Returns:

The float value of this float object.

toString

public String toString()

Overrides:

toString in class Object

toString

public static String toString(double value)

Returns Soy's idea of a double as a string.

coerceToBoolean

public boolean coerceToBoolean()

Coerces this value into a boolean.

0.0 is falsy as is NaN.

Returns:

This value coerced into a boolean.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Returns:

This value coerced into a string.

toFloat

public double toFloat()

Description copied from class: NumberData

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.

Specified by:

toFloat in class NumberData

Returns:

The float value of this number data object.