Package com.hubspot.jinjava.lib.filter

Class AbstractFilter

java.lang.Object

com.hubspot.jinjava.lib.filter.AbstractFilter

All Implemented Interfaces:

Filter, Importable

Direct Known Subclasses:

DefaultFilter, IndentFilter

public abstract class AbstractFilter
extends Object
implements Filter

Filter base that uses Filter Jinjavadoc to construct named argument parameters. Only filters that specify name, type and defaults correctly should use this as a base

See Also:

JinjavaDoc, JinjavaParam

Constructor Summary

Constructors

Constructor	Description
AbstractFilter()

Method Summary

Modifier and Type	Method	Description
Object	filter(Object var, JinjavaInterpreter interpreter, Object[] args, Map<String,Object> kwargs)
Object	filter(Object var, JinjavaInterpreter interpreter, String... args)	Filter the specified template variable within the context of a render process.
String	getIndexedArgumentName(int position)
int	getNamedArgumentPosition(String argName)
Map<String,Object>	initDefaultValues()
Map<String,JinjavaParam>	initNamedArguments()
protected Object	parseArg(JinjavaInterpreter interpreter, JinjavaParam jinjavaParamMetadata, Object value)
void	validateArgs(JinjavaInterpreter interpreter, Map<String,Object> parsedArgs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hubspot.jinjava.lib.filter.Filter

filter, preserveSafeString

Methods inherited from interface com.hubspot.jinjava.lib.Importable

getName

Constructor Detail

AbstractFilter

public AbstractFilter()

Method Detail

filter

public Object filter(Object var,
                     JinjavaInterpreter interpreter,
                     String... args)

Description copied from interface: Filter

Filter the specified template variable within the context of a render process. {{ myvar|myfiltername(arg1,arg2) }}

Specified by:

filter in interface Filter

Parameters:

var - the variable which this filter should operate on

interpreter - current interpreter context

args - any arguments passed to this filter invocation

Returns:

the filtered form of the given variable

filter

public Object filter(Object var,
                     JinjavaInterpreter interpreter,
                     Object[] args,
                     Map<String,Object> kwargs)

Specified by:

filter in interface Filter

parseArg

protected Object parseArg(JinjavaInterpreter interpreter,
                          JinjavaParam jinjavaParamMetadata,
                          Object value)

validateArgs

public void validateArgs(JinjavaInterpreter interpreter,
                         Map<String,Object> parsedArgs)

getNamedArgumentPosition

public int getNamedArgumentPosition(String argName)

getIndexedArgumentName

public String getIndexedArgumentName(int position)

initNamedArguments

public Map<String,JinjavaParam> initNamedArguments()

initDefaultValues

public Map<String,Object> initDefaultValues()