org.sitemesh.tagprocessor
Interface TagTokenizer.TokenHandler

Enclosing class:

TagTokenizer

public static interface TagTokenizer.TokenHandler

Handler that will receive callbacks as 'tags' and 'text' are encountered.

Method Summary

boolean	shouldProcessTag(String name) Before attempting to parse a tag, the tokenizer will ask the handler whether the tag should be processed - avoiding additional tag parsing makes the tokenizer quicker.
void	tag(Tag tag) Called when tokenizer encounters an HTML tag (open, close or empty).
void	text(CharSequence text) Called when tokenizer encounters anything other than a well-formed HTML tag.
void	warning(String message, int line, int column) Called when tokenizer encounters something it cannot correctly parse.

Method Detail

shouldProcessTag

boolean shouldProcessTag(String name)

Before attempting to parse a tag, the tokenizer will ask the handler whether the tag should be processed - avoiding additional tag parsing makes the tokenizer quicker.

If true is returned, the tokenizer will fully parse the tag and pass it into the tag(Tag) method. Otherwise, the tokenizer will not try to parse the tag and pass it to the text(CharSequence) method, untouched.

tag

void tag(Tag tag)
         throws IOException

Called when tokenizer encounters an HTML tag (open, close or empty).

The Tag instance passed in should not be kept beyond the scope of this method as the tokenizer will attempt to reuse it.

Throws:

IOException

text

void text(CharSequence text)
          throws IOException

Called when tokenizer encounters anything other than a well-formed HTML tag.

Throws:

IOException

warning

void warning(String message,
             int line,
             int column)

Called when tokenizer encounters something it cannot correctly parse. Typically the parsing will continue and the unparseable will be treated as a plain text block, however this callback provides indication of this.

Parameters:

message - Error message

line - Line number in input that error occured

column - Column number in input that error occured