com.mitchellbosecke.pebble.tokenParser

Class FilterTokenParser

java.lang.Object

com.mitchellbosecke.pebble.tokenParser.AbstractTokenParser

com.mitchellbosecke.pebble.tokenParser.FilterTokenParser

All Implemented Interfaces:

TokenParser

public class FilterTokenParser
extends AbstractTokenParser

Parses the "filter" tag. It has nothing to do with implementing normal filters.

Field Summary

Fields inherited from class com.mitchellbosecke.pebble.tokenParser.AbstractTokenParser

parser

Constructor Summary

Constructors

Constructor and Description
FilterTokenParser()

Method Summary

Modifier and Type	Method and Description
String	getTag() The "tag" is used to determine when to use a particular instance of a TokenParser.
RenderableNode	parse(Token token) The TokenParser is responsible to convert all the necessary tokens into appropriate Nodes.

Methods inherited from class com.mitchellbosecke.pebble.tokenParser.AbstractTokenParser

setParser

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterTokenParser

public FilterTokenParser()

Method Detail

parse

public RenderableNode parse(Token token)
                     throws ParserException

Description copied from interface: TokenParser

The TokenParser is responsible to convert all the necessary tokens into appropriate Nodes. It can access tokens using parser.getTokenStream(). The tag may be self contained like the "extends" tag or it may have a start and end point with content in the middle like the "block" tag. If it contains content in the middle, it can use parser.subparse(stopCondition) to parse the middle content at which point responsibility comes back to the TokenParser to parse the end point. It is the responsibility of the TokenParser to ensure that when it is complete, the "current" token of the primary Parser's TokenStream is pointing to the NEXT token. USUALLY this means the last statement in this parse method, immediately prior to the return statement, is the following which will consume one token: stream.expect(Token.Type.EXECUTE_END); Here are two relatively simple examples of how TokenParsers are implemented: - self contained: com.mitchellbosecke.pebble.tokenParser.SetTokenParser - middle content: com.mitchellbosecke.pebble.tokenParser.BlockTokenParser

Parameters:

token - The token to parse

Returns:

A node representation of the token

Throws:

ParserException - Thrown if an error occurs while parsing the token

getTag

public String getTag()

Description copied from interface: TokenParser

The "tag" is used to determine when to use a particular instance of a TokenParser. For example, the TokenParser that handles the "block" tag would return "block" with this method.

Returns:

The tag used to define this TokenParser.