liqp.filters

Class Filter

java.lang.Object

liqp.LValue

liqp.filters.Filter

public abstract class Filter
extends LValue

Output markup takes filters. Filters are simple methods. The first parameter is always the output of the left side of the filter. The return value of the filter will be the new left value when the next filter is run. When there are no more filters, the template will receive the resulting string.

-- https://github.com/Shopify/liquid/wiki/Liquid-for-Designers

Field Summary

Fields

Modifier and Type	Field and Description
String	name The name of the filter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Filter() Used for all package protected filters in the liqp.filters-package whose name is their class name lower cased.
	Filter(String name) Creates a new instance of a Filter.

Method Summary

Modifier and Type	Method and Description
abstract Object	apply(Object value, Object... params) Applies the filter on the 'value'.
void	checkParams(Object[] params, int expected) Check the number of parameters and throws an exception if needed.
protected Object	get(int index, Object... params) Returns a value at a specific index from an array of parameters.
static Filter	getFilter(String name) Retrieves a filter with a specific name.
static Map<String,Filter>	getFilters() Returns all default filters.
static void	registerFilter(Filter filter) Registers a new filter.

Methods inherited from class liqp.LValue

areEqual, asArray, asBoolean, asNumber, asString, isArray, isInteger, isNumber, isString

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

The name of the filter.

Constructor Detail

Filter

protected Filter()

Used for all package protected filters in the liqp.filters-package whose name is their class name lower cased.

Filter

public Filter(String name)

Creates a new instance of a Filter.

Parameters:

name - the name of the filter.

Method Detail

apply

public abstract Object apply(Object value,
                             Object... params)

Applies the filter on the 'value'.

Parameters:

value - the string value `AAA` in: `{{ 'AAA' | f:1,2,3 }}`

params - the values [1, 2, 3] in: `{{ 'AAA' | f:1,2,3 }}`

Returns:

the result of the filter.

checkParams

public final void checkParams(Object[] params,
                              int expected)

Check the number of parameters and throws an exception if needed.

Parameters:

params - the parameters to check.

expected - the expected number of parameters.

get

protected Object get(int index,
                     Object... params)

Returns a value at a specific index from an array of parameters. If no such index exists, a RuntimeException is thrown.

Parameters:

index - the index of the value to be retrieved.

params - the values.

Returns:

a value at a specific index from an array of parameters.

getFilter

public static Filter getFilter(String name)

Retrieves a filter with a specific name.

Parameters:

name - the name of the filter to retrieve.

Returns:

a filter with a specific name.

getFilters

public static Map<String,Filter> getFilters()

Returns all default filters.

Returns:

all default filters.

registerFilter

public static void registerFilter(Filter filter)

Registers a new filter.

Parameters:

filter - the filter to be registered.