EscapeHtmlDirective (Closure Templates)

java.lang.Object
- com.google.template.soy.coredirectives.EscapeHtmlDirective

All Implemented Interfaces:

SoyJsSrcPrintDirective, SoyPySrcPrintDirective, ShortCircuitable, SoyJavaPrintDirective, SoyPrintDirective
```
@Singleton
public class EscapeHtmlDirective
extends Object
implements SoyJavaPrintDirective, SoyJsSrcPrintDirective, SoyPySrcPrintDirective, ShortCircuitable
```
A directive that HTML-escapes the output.

Field Summary

Fields
Modifier and Type Field and Description

static String NAME

Fields
Modifier and Type	Field and Description
`static String`	`NAME`

Constructor Summary

Constructors
Constructor and Description

EscapeHtmlDirective()

Constructors
Constructor and Description
`EscapeHtmlDirective()`

Method Summary

Methods
Modifier and Type	Method and Description
`SoyValue`	`applyForJava(SoyValue value, List<SoyValue> args)` Applies this directive on the given value.
`JsExpr`	`applyForJsSrc(JsExpr value, List<JsExpr> args)` Applies this directive on the given string value.
`PyExpr`	`applyForPySrc(PyExpr value, List<PyExpr> args)` Applies this directive on the given string value.
`String`	`getName()` Gets the name of the Soy print directive.
`Set<Integer>`	`getValidArgsSizes()` Gets the set of valid args list sizes.
`boolean`	`isNoopForKind(SanitizedContent.ContentKind kind)` Returns true if this directive will turn into a no-op when passed values of the given content kind.
`boolean`	`shouldCancelAutoescape()` Returns whether the appearance of this directive on a 'print' tag should cancel autoescape for that 'print' tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - EscapeHtmlDirective
```
@Inject
public EscapeHtmlDirective()
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: SoyPrintDirective
    
    Gets the name of the Soy print directive.
    
    Specified by:
    
    getName in interface SoyPrintDirective
    
    Returns:
    The name of the Soy print directive.
  - getValidArgsSizes
```
public Set<Integer> getValidArgsSizes()
```
    Description copied from interface: SoyPrintDirective
    
    Gets the set of valid args list sizes. For example, the set {0, 2} would indicate that this directive can take 0 or 2 arguments (but not 1).
    
    Specified by:
    
    getValidArgsSizes in interface SoyPrintDirective
    
    Returns:
    The set of valid args list sizes.
  - shouldCancelAutoescape
```
public boolean shouldCancelAutoescape()
```
    Description copied from interface: SoyPrintDirective
    
    Returns whether the appearance of this directive on a 'print' tag should cancel autoescape for that 'print' tag.
    
    Specified by:
    
    shouldCancelAutoescape in interface SoyPrintDirective
    
    Returns:
    Whether the appearance of this directive on a 'print' tag should cancel autoescape for that 'print' tag.
  - isNoopForKind
```
public boolean isNoopForKind(SanitizedContent.ContentKind kind)
```
    Description copied from interface: ShortCircuitable
    
    Returns true if this directive will turn into a no-op when passed values of the given content kind.
    
    Specified by:
    
    isNoopForKind in interface ShortCircuitable
  - applyForJava
```
public SoyValue applyForJava(SoyValue value,
                    List<SoyValue> args)
```
    Description copied from interface: SoyJavaPrintDirective
    
    Applies this directive on the given value.
    
    Specified by:
    
    applyForJava in interface SoyJavaPrintDirective
    
    Parameters:
    value - The input to the directive. This is not necessarily a string. If a directive only applies to string inputs, then it should first call coerceToString() on this input value.
    args - The directive's arguments, if any (often none).
    
    Returns:
    The resulting value. Must be either StringData or SanitizedContent.
  - applyForJsSrc
```
public JsExpr applyForJsSrc(JsExpr value,
                   List<JsExpr> args)
```
    Description copied from interface: SoyJsSrcPrintDirective
    
    Applies this directive on the given string value.
    Important note when implementing this method: The string value may not yet have been coerced to a string. You may need to explicitly coerce it to a string using the JS function String().
    
    Specified by:
    
    applyForJsSrc in interface SoyJsSrcPrintDirective
    
    Parameters:
    value - The value to apply the directive on. This value may not yet have been coerced to a string.
    args - The directive's arguments, if any (usually none).
    
    Returns:
    The resulting value.
  - applyForPySrc
```
public PyExpr applyForPySrc(PyExpr value,
                   List<PyExpr> args)
```
    Description copied from interface: SoyPySrcPrintDirective
    
    Applies this directive on the given string value.
    Important note when implementing this method: The string value may not yet have been coerced to a string. You may need to explicitly coerce it to a string expression using PyExpr.toPyString().
    
    Specified by:
    
    applyForPySrc in interface SoyPySrcPrintDirective
    
    Parameters:
    value - The value to apply the directive on. This value may not yet have been coerced to a string.
    args - The directive's arguments, if any (usually none).
    
    Returns:
    The resulting value.

Class EscapeHtmlDirective

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

EscapeHtmlDirective

Method Detail

getName

getValidArgsSizes

shouldCancelAutoescape

isNoopForKind

applyForJava

applyForJsSrc

applyForPySrc