SanitizedContent (Closure Templates)

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.

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

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`boolean`	`toBoolean()` Deprecated.
`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.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`.
`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

Methods inherited from class com.google.template.soy.data.SoyAbstractValue
booleanValue, floatValue, integerValue, longValue, numberValue, 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, coerceToBoolean, coerceToString, floatValue, integerValue, longValue, numberValue, 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 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 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.
  - 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.

Class SanitizedContent

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Method Detail

getContent

getContentKind

getContentDirection

toBoolean

toString

stringValue

equals

hashCode

toSafeHtml

toSafeHtmlProto

toSafeStyleSheet

toSafeStyleSheetProto