Package io.pebbletemplates.pebble.tokenParser

Class ExtendsTokenParser

java.lang.Object
io.pebbletemplates.pebble.tokenParser.ExtendsTokenParser
All Implemented Interfaces:
TokenParser
public class ExtendsTokenParser extends Object implements TokenParser

  • Constructor Details

    • ExtendsTokenParser

      public ExtendsTokenParser()

  • Method Details

    • parse

      public RenderableNode parse(Token token, Parser parser)
      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: io.pebbletemplates.tokenParser.pebble.SetTokenParser - middle content: io.pebbletemplates.tokenParser.pebble.BlockTokenParser
      Specified by:
      parse in interface TokenParser
      Parameters:
      token - The token to parse
      parser - the parser which should be used to parse the token
      Returns:
      A node representation of 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.
      Specified by:
      getTag in interface TokenParser
      Returns:
      The tag used to define this TokenParser.