Package com.tameif.tame.lang

Class FormatParser

java.lang.Object

com.tameif.tame.lang.FormatParser

public abstract class FormatParser
extends java.lang.Object

The formatting parser for formatted text. Formatted text uses a format like UBB that uses [tag] and [/] to surround text in order to style it. In order to escape the bracket characters ('[' and ']'), add them twice (eg. "[[" outputs as "["). The protected methods are called at tag boundaries as they are read.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
FormatParser() Creates a new text formatting parser.

Method Summary

Modifier and Type	Method and Description
abstract void	endTag(java.lang.String tagName) Called at the end of a tag.
void	parse(java.lang.CharSequence sequence) Parses a string and calls the tag methods
abstract void	sendText(java.lang.String text) Called when a chunk of text needs to be output (before/in/after tags).
abstract void	startTag(java.lang.String tagName) Called at the start of a tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatParser

public FormatParser()

Creates a new text formatting parser.

Method Detail

parse

public void parse(java.lang.CharSequence sequence)

Parses a string and calls the tag methods

Parameters:

sequence - the input text to parse.

startTag

public abstract void startTag(java.lang.String tagName)

Called at the start of a tag.

Parameters:

tagName - the name of the started tag.

sendText

public abstract void sendText(java.lang.String text)

Called when a chunk of text needs to be output (before/in/after tags).

Parameters:

text - the output text.

endTag

public abstract void endTag(java.lang.String tagName)

Called at the end of a tag.

Parameters:

tagName - the name of the ended tag.