BasicEscapeDirective (Closure Templates)

java.lang.Object
- com.google.template.soy.basicdirectives.BasicEscapeDirective

All Implemented Interfaces:

SoyJsSrcPrintDirective, SoyPySrcPrintDirective, SoyJavaPrintDirective, SoyPrintDirective
```
public abstract class BasicEscapeDirective
extends Object
implements SoyJavaPrintDirective, SoyJsSrcPrintDirective, SoyPySrcPrintDirective
```
An escaping directive that is backed by Sanitizers in java, soyutils.js or the closure equivalent in JavaScript, and sanitize.py in Python. See GenerateSoyUtilsEscapingDirectiveCode which creates the JS code that backs escaping directives, and GeneratePySanitizeEscapingDirectiveCode which creates the Python backing code.

Constructor Summary

Constructors
Constructor and Description

BasicEscapeDirective(String name)

Constructors
Constructor and Description
`BasicEscapeDirective(String name)`

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.
`protected abstract String`	`escape(SoyValue value)` Performs the actual escaping.
`String`	`getName()` The name of the Soy directive that this instance implements.
`Set<Integer>`	`getValidArgsSizes()` Gets the set of valid args list sizes.
`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

- Constructor Detail
  - BasicEscapeDirective
```
public BasicEscapeDirective(String name)
```
    Parameters:
    name - E.g. |escapeUri.
- Method Detail
  - escape
```
protected abstract String escape(SoyValue value)
```
    Performs the actual escaping.
  - getName
```
public final String getName()
```
    The name of the Soy directive that this instance implements.
    
    Specified by:
    
    getName in interface SoyPrintDirective
    
    Returns:
    The name of the Soy print directive.
  - getValidArgsSizes
```
public final 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 final 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.
  - 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 BasicEscapeDirective

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicEscapeDirective

Method Detail

escape

getName

getValidArgsSizes

shouldCancelAutoescape

applyForJava

applyForJsSrc

applyForPySrc