com.google.template.soy.coredirectives

Class EscapeHtmlDirective

java.lang.Object

com.google.template.soy.coredirectives.EscapeHtmlDirective

All Implemented Interfaces:

SoyJbcSrcPrintDirective, SoyJbcSrcPrintDirective.Streamable, SoyJsSrcPrintDirective, SoyLibraryAssistedJsSrcPrintDirective, SoyPySrcPrintDirective, ShortCircuitable, SoyJavaPrintDirective, SoyPrintDirective

@Singleton
public class EscapeHtmlDirective
extends Object
implements SoyJavaPrintDirective, SoyLibraryAssistedJsSrcPrintDirective, SoyPySrcPrintDirective, SoyJbcSrcPrintDirective.Streamable, ShortCircuitable

A directive that HTML-escapes the output.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.jbcsrc.restricted.SoyJbcSrcPrintDirective.Streamable

SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions

Nested classes/interfaces inherited from interface com.google.template.soy.jbcsrc.restricted.SoyJbcSrcPrintDirective

SoyJbcSrcPrintDirective.Streamable

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
EscapeHtmlDirective()

Method Summary

Modifier and Type	Method and Description
SoyValue	applyForJava(SoyValue value, List<SoyValue> args) Applies this directive on the given value.
SoyExpression	applyForJbcSrc(JbcSrcPluginContext context, SoyExpression value, List<SoyExpression> args) Applies this directive on the given value.
SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions	applyForJbcSrcStreaming(JbcSrcPluginContext context, Expression delegateAppendable, List<SoyExpression> args) Applies the directive to a LoggingAdvisingAppendable object.
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.
com.google.common.collect.ImmutableSet<String>	getRequiredJsLibNames() Returns a list of Closure library names to require when this directive is used.
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.

applyForJbcSrc

public SoyExpression applyForJbcSrc(JbcSrcPluginContext context,
                                    SoyExpression value,
                                    List<SoyExpression> args)

Description copied from interface: SoyJbcSrcPrintDirective

Applies this directive on the given value.

Important note when implementing this method: The value may not yet have been coerced to a string. You may need to explicitly coerce it to a string using the SoyExpression.coerceToString().

Specified by:

applyForJbcSrc in interface SoyJbcSrcPrintDirective

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.

applyForJbcSrcStreaming

public SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions applyForJbcSrcStreaming(JbcSrcPluginContext context,
                                                                                       Expression delegateAppendable,
                                                                                       List<SoyExpression> args)

Description copied from interface: SoyJbcSrcPrintDirective.Streamable

Applies the directive to a LoggingAdvisingAppendable object.

Specified by:

applyForJbcSrcStreaming in interface SoyJbcSrcPrintDirective.Streamable

Parameters:

context - The rendering context object.

delegateAppendable - The delegate appendable

args - The print directive arguments.

Returns:

An SoyJbcSrcPrintDirective.Streamable.AppendableAndOptions for the directive.

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.

getRequiredJsLibNames

public com.google.common.collect.ImmutableSet<String> getRequiredJsLibNames()

Description copied from interface: SoyLibraryAssistedJsSrcPrintDirective

Returns a list of Closure library names to require when this directive is used.

Note: Return the raw Closure library names, Soy will wrap them in goog.require for you.

Specified by:

getRequiredJsLibNames in interface SoyLibraryAssistedJsSrcPrintDirective

Returns:

A collection of strings representing Closure JS library names

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.