com.google.template.soy.data

Class SanitizedContent

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyData

com.google.template.soy.data.SanitizedContent

All Implemented Interfaces:

SoyValue, SoyValueProvider

@ParametersAreNonnullByDefault
 @Immutable
public abstract class SanitizedContent
extends SoyData

A chunk of sanitized content of a known kind, e.g. the output of an HTML sanitizer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SanitizedContent.ContentKind A kind of textual content.

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

SoyValueProvider.ResolveStatus

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) This was a required method in the old SoyData interface.
abstract String	getContent() Returns a string of valid content with kind getContentKind().
Dir	getContentDirection() Returns the content's direction; null indicates that the direction is unknown, and is to be estimated when necessary.
SanitizedContent.ContentKind	getContentKind() Returns the kind of content.
int	hashCode()
String	stringValue() Returns the string value.
boolean	toBoolean() Deprecated.
String	toString() This was a required method in the old SoyData interface.

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

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

render

Method Detail

getContent

public abstract String getContent()

Returns a string of valid content with kind getContentKind().

getContentKind

public SanitizedContent.ContentKind getContentKind()

Returns the kind of content.

getContentDirection

@Nullable
public Dir getContentDirection()

Returns the content's direction; null indicates that the direction is unknown, and is to be estimated when necessary.

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.

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.

stringValue

public String stringValue()

Returns the string value. In contexts where a string value is required, SanitizedCOntent is permitted.

Specified by:

stringValue in interface SoyValue

Overrides:

stringValue in class SoyAbstractValue

Returns:

The string value of this string object.

equals

public boolean equals(@Nullable
                      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