FloatData (Closure Templates)

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`boolean`	`toBoolean()` Deprecated.
`double`	`toFloat()` Gets the float value of this number data object.
`String`	`toString()` This was a required method in the old SoyData interface.
`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
coerceToBoolean, coerceToString, createFromExistingData

Methods inherited from class com.google.template.soy.data.SoyAbstractValue
booleanValue, integerValue, longValue, 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()
```
    Description copied from class: SoyData
    
    This was a required method in the old SoyData interface. For new data classes, please use interface SoyValue, which has the method coerceToString(). Converts this data object into a string (e.g. when used in a string context).
    
    Specified by:
    
    toString in class SoyData
    
    Returns:
    The value of this data object if coerced into a string.
  - toString
```
public static String toString(double value)
```
    Returns Soy's idea of a double as a string.
  - toBoolean
```
@Deprecated
public boolean toBoolean()
```
    Deprecated.
    
    This was a required method in the old SoyData interface. For new data classes, please use interface SoyValue, which has the method coerceToBoolean(). Converts this data object into a boolean (e.g. when used in a boolean context). In other words, this method tells whether this object is truthy.
    0.0 is falsy as is NaN.
    
    Specified by:
    
    toBoolean in class SoyData
    
    Returns:
    The value of this data object if coerced into a boolean. I.e. true if this object is truthy, false if this object is falsy.
  - 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.

Class FloatData

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

FloatData

Method Detail

forValue

getValue

floatValue

toString

toString

toBoolean

toFloat