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

Constructor Summary

Constructors

Constructor and Description
BooleanData(boolean value) Deprecated. Use TRUE, FALSE, or forValue(boolean).

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	equals(Object other) This was a required method in the old SoyData interface.
static BooleanData	forValue(boolean value) Gets a BooleanData instance for the given value.
boolean	getValue() Returns the boolean value.
int	hashCode()
boolean	toBoolean() Deprecated.
String	toString() This was a required method in the old SoyData interface.

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, equals

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

equals, floatValue, integerValue, longValue, numberValue, resolve, 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'.

Constructor Detail

BooleanData

@Deprecated
public BooleanData(boolean value)

Deprecated. Use TRUE, FALSE, or forValue(boolean).

Parameters:

value - The boolean value.

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

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.

toBoolean

@Deprecated
public boolean toBoolean()

Deprecated.

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

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.

equals

public boolean equals(Object other)

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 equals(SoyValue). Compares this data object against another for equality in the sense of the operator '==' for Soy expressions.

Specified by:

equals in class SoyData

Parameters:

other - The other data object to compare against.

Returns:

True if the two objects are equal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object