Package io.pebbletemplates.pebble.extension.escaper

Class EscaperExtension

java.lang.Object

io.pebbletemplates.pebble.extension.AbstractExtension

io.pebbletemplates.pebble.extension.escaper.EscaperExtension

All Implemented Interfaces:

Extension

public class EscaperExtension
extends AbstractExtension

Field Summary

Fields

Modifier and Type	Field	Description
private EscapeFilter	filter
private EscaperNodeVisitorFactory	visitorFactory

Constructor Summary

Constructors

Constructor	Description
EscaperExtension()

Method Summary

Modifier and Type	Method	Description
void	addEscapingStrategy(java.lang.String name, EscapingStrategy strategy)	Adds a custom escaping strategy to the filter.
java.util.Map<java.lang.String,Filter>	getFilters()	Use this method to provide custom filters.
java.util.List<NodeVisitorFactory>	getNodeVisitors()	Node visitors will travel the AST tree during the compilation phase.
java.util.List<TokenParser>	getTokenParsers()	Use this method to provide custom tags.
void	setAutoEscaping(boolean auto)
void	setDefaultStrategy(java.lang.String strategy)	Sets the default escaping strategy.

Methods inherited from class io.pebbletemplates.pebble.extension.AbstractExtension

getAttributeResolver, getBinaryOperators, getFunctions, getGlobalVariables, getTests, getUnaryOperators

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filter

private final EscapeFilter filter

visitorFactory

private final EscaperNodeVisitorFactory visitorFactory

Constructor Detail

EscaperExtension

public EscaperExtension()

Method Detail

getFilters

public java.util.Map<java.lang.String,Filter> getFilters()

Description copied from interface: Extension

Use this method to provide custom filters.

Specified by:

getFilters in interface Extension

Overrides:

getFilters in class AbstractExtension

Returns:

A list of filters. It is okay to return null.

getTokenParsers

public java.util.List<TokenParser> getTokenParsers()

Description copied from interface: Extension

Use this method to provide custom tags. A TokenParser is used to parse a stream of tokens into Nodes which are then responsible for compiling themselves into Java.

Specified by:

getTokenParsers in interface Extension

Overrides:

getTokenParsers in class AbstractExtension

Returns:

A list of TokenParsers. It is okay to return null.

getNodeVisitors

public java.util.List<NodeVisitorFactory> getNodeVisitors()

Description copied from interface: Extension

Node visitors will travel the AST tree during the compilation phase.

Specified by:

getNodeVisitors in interface Extension

Overrides:

getNodeVisitors in class AbstractExtension

Returns:

a list of node visitors

setDefaultStrategy

public void setDefaultStrategy(java.lang.String strategy)

Sets the default escaping strategy.

Parameters:

strategy - Escaping strategy

setAutoEscaping

public void setAutoEscaping(boolean auto)

addEscapingStrategy

public void addEscapingStrategy(java.lang.String name,
                                EscapingStrategy strategy)

Adds a custom escaping strategy to the filter.

Parameters:

name - Name of the escaping strategy

strategy - The implementation of the escaping strategy