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:

SoyValue, SoyValueProvider

@Immutable
public abstract class StringData
extends PrimitiveData

String data.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.data.SoyValueProvider

SoyValueProvider.ResolveStatus

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	equals(Object other) This was a required method in the old SoyData interface.
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.
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

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

Methods inherited from class java.lang.Object

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

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

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.

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.

The empty string is falsy.

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