com.opensymphony.module.sitemesh.html.tokenizer
Interface TokenHandler

public interface TokenHandler

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

Author:

Joe Walnes

See Also:

TagTokenizer

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(Text 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

public 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(com.opensymphony.module.sitemesh.html.Tag) method. If false is returned, the tokenizer will not try to parse the tag and pass it to the #text(com.opensymphony.module.sitemesh.html.Text) method, untouched.

tag

public void tag(Tag tag)

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.

text

public void text(Text text)

Called when tokenizer encounters anything other than a well-formed HTML tag. The Text object is used instead of a String to allow the String to be lazy-loaded. The Text instance passed in should not be kept beyond the scope of this method as the tokenizer will attempt to reuse it.

warning

public 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