com.google.template.soy.shared.restricted

Interface SoyPrintDirective

All Known Subinterfaces:

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

All Known Implementing Classes:

BasicEscapeDirective, EscapeHtmlDirective, IdDirective, NoAutoescapeDirective

public interface SoyPrintDirective

Superinterface for a Soy print directive.

Important: Implementing this interface by itself does nothing. Your directive implementation class needs to implement some of all of this interface's subinterfaces.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getName

String getName()

Gets the name of the Soy print directive.

Returns:

The name of the Soy print directive.

getValidArgsSizes

Set<Integer> getValidArgsSizes()

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).

Returns:

The set of valid args list sizes.

shouldCancelAutoescape

boolean shouldCancelAutoescape()

Returns whether the appearance of this directive on a 'print' tag should cancel autoescape for that 'print' tag.

Returns:

Whether the appearance of this directive on a 'print' tag should cancel autoescape for that 'print' tag.