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:

SoyString, SoyValue, SoyValueProvider

@ParametersAreNonnullByDefault
 @Immutable
public abstract class SanitizedContent
extends SoyData
implements SoyString

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.

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.
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.
com.google.common.html.types.SafeHtml	toSafeHtml() Converts a Soy SanitizedContent of kind HTML into a SafeHtml.
com.google.common.html.types.SafeHtmlProto	toSafeHtmlProto() Converts a Soy SanitizedContent of kind HTML into a SafeHtmlProto.
com.google.common.html.types.SafeScriptProto	toSafeScriptProto() Converts a Soy SanitizedContent of kind JS into a SafeScriptProto.
com.google.common.html.types.SafeStyleProto	toSafeStyleProto() Converts a Soy SanitizedContent of kind CSS into a SafeStyleProto.
com.google.common.html.types.SafeStyleSheet	toSafeStyleSheet() Converts a Soy SanitizedContent of kind CSS into a SafeStyleSheet.
com.google.common.html.types.SafeStyleSheetProto	toSafeStyleSheetProto() Converts a Soy SanitizedContent of kind CSS into a SafeStyleSheetProto.
com.google.common.html.types.SafeUrlProto	toSafeUrlProto() Converts a Soy SanitizedContent of kind URI into a SafeUrlProto.
String	toString()
com.google.common.html.types.TrustedResourceUrlProto	toTrustedResourceUrlProto() Converts a Soy SanitizedContent of kind TRUSTED_RESOURCE_URI into a TrustedResourceUrlProto.

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

Method Detail

getContent

public abstract String getContent()

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

getContentKind

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

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

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.

toString

public String toString()

Overrides:

toString in class Object

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

toSafeHtml

public com.google.common.html.types.SafeHtml toSafeHtml()

Converts a Soy SanitizedContent of kind HTML into a SafeHtml.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.HTML.

toSafeHtmlProto

public com.google.common.html.types.SafeHtmlProto toSafeHtmlProto()

Converts a Soy SanitizedContent of kind HTML into a SafeHtmlProto.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.HTML.

toSafeScriptProto

public com.google.common.html.types.SafeScriptProto toSafeScriptProto()

Converts a Soy SanitizedContent of kind JS into a SafeScriptProto.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.JS.

toSafeStyleProto

public com.google.common.html.types.SafeStyleProto toSafeStyleProto()

Converts a Soy SanitizedContent of kind CSS into a SafeStyleProto.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.CSS.

toSafeStyleSheet

public com.google.common.html.types.SafeStyleSheet toSafeStyleSheet()

Converts a Soy SanitizedContent of kind CSS into a SafeStyleSheet.

To ensure correct behavior and usage, the SanitizedContent object should fulfill the contract of SafeStyleSheet - the CSS content should represent the top-level content of a style element within HTML.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.CSS.

toSafeStyleSheetProto

public com.google.common.html.types.SafeStyleSheetProto toSafeStyleSheetProto()

Converts a Soy SanitizedContent of kind CSS into a SafeStyleSheetProto.

To ensure correct behavior and usage, the SanitizedContent object should fulfill the contract of SafeStyleSheet - the CSS content should represent the top-level content of a style element within HTML.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.CSS.

toSafeUrlProto

public com.google.common.html.types.SafeUrlProto toSafeUrlProto()

Converts a Soy SanitizedContent of kind URI into a SafeUrlProto.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.URI.

toTrustedResourceUrlProto

public com.google.common.html.types.TrustedResourceUrlProto toTrustedResourceUrlProto()

Converts a Soy SanitizedContent of kind TRUSTED_RESOURCE_URI into a TrustedResourceUrlProto.

Throws:

IllegalStateException - if this SanitizedContent's content kind is not SanitizedContent.ContentKind.TRUSTED_RESOURCE_URI.