liqp

Class Template

java.lang.Object

liqp.Template

public class Template
extends Object

The main class of this library. Use one of its static parse(...) to get a hold of a reference.

Also see: https://github.com/Shopify/liquid

Method Summary

Modifier and Type	Method and Description
org.antlr.runtime.tree.CommonTree	getAST() Returns the root of the AST of the parsed input.
static Template	parse(File file) Returns a new Template instance from a given input file.
static Template	parse(File file, Flavor flavor)
static Template	parse(String input) Returns a new Template instance from a given input string.
static Template	parse(String input, Flavor flavor)
String	render()
String	render(Map<String,Object> variables) Renders the template.
String	render(Object key, Object value, Object... keyValues) Renders the template.
String	render(String jsonMap) Renders the template.
String	toStringAST() Returns a string representation of the AST of the parsed input source.
Template	with(Filter filter)
Template	with(Tag tag)
Template	withProtectionSettings(ProtectionSettings protectionSettings)

Methods inherited from class java.lang.Object

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

Method Detail

getAST

public org.antlr.runtime.tree.CommonTree getAST()

Returns the root of the AST of the parsed input.

Returns:

the root of the AST of the parsed input.

parse

public static Template parse(String input)

Returns a new Template instance from a given input string.

Parameters:

input - the input string holding the Liquid source.

Returns:

a new Template instance from a given input string.

parse

public static Template parse(File file)
                      throws IOException

Returns a new Template instance from a given input file.

Parameters:

file - the input file holding the Liquid source.

Returns:

a new Template instance from a given input file.

Throws:

IOException

parse

public static Template parse(File file,
                             Flavor flavor)
                      throws IOException

Throws:

IOException

parse

public static Template parse(String input,
                             Flavor flavor)
                      throws IOException

Throws:

IOException

with

public Template with(Tag tag)

with

public Template with(Filter filter)

withProtectionSettings

public Template withProtectionSettings(ProtectionSettings protectionSettings)

render

public String render(String jsonMap)

Renders the template.

Parameters:

jsonMap - a JSON-map denoting the (possibly nested) variables that can be used in this Template.

Returns:

a string denoting the rendered template.

render

public String render()

render

public String render(Object key,
                     Object value,
                     Object... keyValues)

Renders the template.

Parameters:

key - a key

value - the value belonging to the key

keyValues - an array denoting key-value pairs where the uneven numbers (even indexes) should be Strings. If the length of this array is uneven, the last key (without the value) gets `null` attached to it. Note that a call to this method with a single String as parameter, will be handled by `render(String jsonMap)` instead.

Returns:

a string denoting the rendered template.

render

public String render(Map<String,Object> variables)

Renders the template.

Parameters:

variables - a Map denoting the (possibly nested) variables that can be used in this Template.

Returns:

a string denoting the rendered template.

toStringAST

public String toStringAST()

Returns a string representation of the AST of the parsed input source.

Returns:

a string representation of the AST of the parsed input source.