com.google.template.soy.data.restricted

Class StringData

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

All Implemented Interfaces:

SoyString, SoyValue, SoyValueProvider

@Immutable
public abstract class StringData
extends PrimitiveData
implements SoyString

String 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 StringData	EMPTY_STRING Static instance of StringData with value "".

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 StringData	forThunk(RenderableThunk thunk) Returns a StringData instance for the given RenderableThunk.
static StringData	forValue(String value) Gets a StringData instance for the given value.
abstract String	getValue() Returns the string value.
int	hashCode()
String	stringValue() Precondition: Only call this method if you know that this SoyValue object is a string.
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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.template.soy.data.SoyValue

booleanValue, floatValue, integerValue, longValue, numberValue, render, render

Methods inherited from interface com.google.template.soy.data.SoyValueProvider

renderAndResolve, resolve, status

Field Detail

EMPTY_STRING

public static final StringData EMPTY_STRING

Static instance of StringData with value "".

Method Detail

forValue

public static StringData forValue(String value)

Gets a StringData instance for the given value.

Parameters:

value - The desired value.

Returns:

A StringData instance with the given value.

forThunk

public static StringData forThunk(RenderableThunk thunk)

Returns a StringData instance for the given RenderableThunk.

getValue

public abstract String getValue()

Returns the string value.

stringValue

public String stringValue()

Description copied from interface: SoyValue

Precondition: Only call this method if you know that this SoyValue object is a string. This method gets the string value of this string object.

Specified by:

stringValue in interface SoyValue

Overrides:

stringValue in class SoyAbstractValue

Returns:

The string value of this string object.

toString

public String toString()

Overrides:

toString in class Object

coerceToBoolean

public boolean coerceToBoolean()

Coerces this value into a boolean.

The empty string is falsy.

Specified by:

coerceToBoolean in interface SoyValue

Returns:

This value coerced into a boolean.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Specified by:

coerceToString in interface SoyValue

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