com.google.template.soy.basicdirectives

Class InsertWordBreaksDirective

java.lang.Object

com.google.template.soy.basicdirectives.InsertWordBreaksDirective

All Implemented Interfaces:

SanitizedContentOperator, SoyJsSrcPrintDirective, SoyJavaPrintDirective, SoyPrintDirective

@Singleton
public class InsertWordBreaksDirective
extends Object
implements SanitizedContentOperator, SoyJavaPrintDirective, SoyJsSrcPrintDirective

A directive that inserts word breaks as necessary. It takes a single argument : an integer specifying the max number of characters between breaks.

Method Summary

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.
SanitizedContent.ContentKind	getContentKind() The kind of content consumed and produced.
String	getName() Gets the name of the Soy print directive.
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

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.

getContentKind

@Nonnull
public SanitizedContent.ContentKind getContentKind()

Description copied from interface: SanitizedContentOperator

The kind of content consumed and produced.

Specified by:

getContentKind in interface SanitizedContentOperator

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.