com.google.template.soy.data.restricted

Class IntegerData

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

All Implemented Interfaces:

SoyValue, SoyValueProvider

@Immutable
public final class IntegerData
extends NumberData

Integer data.

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

Field Summary

Fields

Modifier and Type	Field and Description
static IntegerData	MINUS_ONE Static instance of IntegerData with value -1.
static IntegerData	ONE Static instance of IntegerData with value 1.
static IntegerData	ZERO Static instance of IntegerData with value 0.

Method Summary

Modifier and Type	Method and Description
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
boolean	equals(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
static IntegerData	forValue(long value) Gets a IntegerData instance for the given value.
long	getValue() Returns the integer value.
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	toFloat() Gets the float value of this number data object.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final IntegerData ZERO

Static instance of IntegerData with value 0.

ONE

public static final IntegerData ONE

Static instance of IntegerData with value 1.

MINUS_ONE

public static final IntegerData MINUS_ONE

Static instance of IntegerData with value -1.

Method Detail

forValue

public static IntegerData forValue(long value)

Gets a IntegerData instance for the given value.

Parameters:

value - The desired value.

Returns:

A IntegerData instance with the given value.

getValue

public long getValue()

Returns the integer value.

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

Overrides:

integerValue in class SoyAbstractValue

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

Overrides:

longValue in class SoyAbstractValue

Returns:

The integer value of this integer object.

toString

public String toString()

Overrides:

toString in class Object

coerceToBoolean

public boolean coerceToBoolean()

Coerces this value into a boolean.

0 is falsy.

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.

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

Overrides:

equals in class NumberData

Parameters:

other - The other value to compare against.

Returns:

True if this value is equal to the other in the sense of Soy.