com.x5.template.filters

Class FilterArgs

java.lang.Object

com.x5.template.filters.FilterArgs

public class FilterArgs
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FilterArgs(java.lang.String filterInvocation)

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getArgsAsObjects(Chunk context) When passing tag values as filter args, you may want to manipulate the original object within the filter logic, ie and not its string representation.
java.lang.String[]	getDeepRefPath()
java.lang.String[]	getFilterArgs() Deprecated. use getFilterArgs(Chunk) instead.
java.lang.String[]	getFilterArgs(Chunk context) When getFilterArgs is provided with a context, backticks will be resolved and args that look like tag values are resolved.
java.lang.String	getFilterName()
java.lang.String	getUnparsedArgs()
java.lang.String	getUnparsedFilter()
java.lang.String[]	getUnresolvedArgs()
static int	grokValidColonScanPoint(java.lang.String wholeTag, int startHere)
static java.lang.String	magicBraces(Chunk context, java.lang.String output) magicBraces wraps unbraced tag-specials $tag ^command +include in {$braces} to trigger proper re-processing later on.
static java.lang.String	magicBraces(Chunk context, java.lang.String output, FilterArgs args)
static int	nextArgDelim(java.lang.String arglist, int searchFrom)
static int	nextUnescapedDelim(java.lang.String delim, java.lang.String regex, int searchFrom)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterArgs

public FilterArgs(java.lang.String filterInvocation)

Method Detail

getFilterName

public java.lang.String getFilterName()

getFilterArgs

@Deprecated
public java.lang.String[] getFilterArgs()

Deprecated. use getFilterArgs(Chunk) instead.

Returns literal filter arguments from original template with no interpolation. If you really want this, use getUnresolvedArgs() instead.

getFilterArgs

public java.lang.String[] getFilterArgs(Chunk context)

When getFilterArgs is provided with a context, backticks will be resolved and args that look like tag values are resolved. The old method signature is deprecated, please always call this version of getFilterArgs.

Parameters:

context -

Returns:

resolved arguments as strings

getArgsAsObjects

public java.lang.Object[] getArgsAsObjects(Chunk context)

When passing tag values as filter args, you may want to manipulate the original object within the filter logic, ie and not its string representation. eg: {$name|myFilter($x,$y.attr,$z)}

Parameters:

context -

Returns:

context-resolved arguments as bare objects

getUnparsedFilter

public java.lang.String getUnparsedFilter()

getUnparsedArgs

public java.lang.String getUnparsedArgs()

getUnresolvedArgs

public java.lang.String[] getUnresolvedArgs()

getDeepRefPath

public java.lang.String[] getDeepRefPath()

magicBraces

public static java.lang.String magicBraces(Chunk context,
                                           java.lang.String output)

magicBraces wraps unbraced tag-specials $tag ^command +include in {$braces} to trigger proper re-processing later on. magicBraces leaves unprefixed values intact.

magicBraces

public static java.lang.String magicBraces(Chunk context,
                                           java.lang.String output,
                                           FilterArgs args)

nextArgDelim

public static int nextArgDelim(java.lang.String arglist,
                               int searchFrom)

nextUnescapedDelim

public static int nextUnescapedDelim(java.lang.String delim,
                                     java.lang.String regex,
                                     int searchFrom)

grokValidColonScanPoint

public static int grokValidColonScanPoint(java.lang.String wholeTag,
                                          int startHere)