com.github.jknack.handlebars

Interface EscapingStrategy

public interface EscapingStrategy

A strategy for determining how to escape a variable ({{variable}})..

Usage:

    EscapingStrategy escapingStrategy = new EscapingStrategy() {
       public String escape(final CharSequence value) {
         // return the character sequence escaped however you want
       }
    };
    Handlebars handlebars = new Handlebars().with(escapingStrategy);
 

Since:

1.2.0

Author:

Tristan Burch

Field Summary

Fields

Modifier and Type	Field and Description
static EscapingStrategy	CSV Escape variable for CSV.
static EscapingStrategy	HTML_ENTITY The default HTML Entity escaping strategy.
static EscapingStrategy	JS Escape variable for JavaScript.
static EscapingStrategy	XML Escape variable for XML.

Method Summary

Methods

Modifier and Type	Method and Description
String	escape(CharSequence value) Escape the CharSequence.

Field Detail

HTML_ENTITY

static final EscapingStrategy HTML_ENTITY

The default HTML Entity escaping strategy.

CSV

static final EscapingStrategy CSV

Escape variable for CSV.

XML

static final EscapingStrategy XML

Escape variable for XML.

JS

static final EscapingStrategy JS

Escape variable for JavaScript.

Method Detail

escape

String escape(CharSequence value)

Escape the CharSequence.

Parameters:

value - the character sequence to be escaped.

Returns:

the escaped character sequence.