com.google.template.soy.data.restricted

Class BooleanData

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

All Implemented Interfaces:

SoyValue, SoyValueProvider

@Immutable
public final class BooleanData
extends PrimitiveData

Boolean 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 BooleanData	FALSE Static instance of BooleanData with value 'false'.
static BooleanData	TRUE Static instance of BooleanData with value 'true'.

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	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 BooleanData	forValue(boolean value) Gets a BooleanData instance for the given value.
boolean	getValue() Returns the boolean value.
int	hashCode()
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final BooleanData TRUE

Static instance of BooleanData with value 'true'.

FALSE

public static final BooleanData FALSE

Static instance of BooleanData with value 'false'.

Method Detail

forValue

public static BooleanData forValue(boolean value)

Gets a BooleanData instance for the given value.

Parameters:

value - The desired value.

Returns:

A BooleanData instance with the given value.

getValue

public boolean getValue()

Returns the boolean value.

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

Overrides:

booleanValue in class SoyAbstractValue

Returns:

The boolean value of this boolean object.

toString

public String toString()

Overrides:

toString in class Object

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

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.

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