se.l4.lect.handlers

Class DefaultHandler

java.lang.Object

se.l4.lect.handlers.DefaultHandler

All Implemented Interfaces:

Handler

public abstract class DefaultHandler
extends Object
implements Handler

Implementation of Handler that provides a starting point for implementing custom handlers. This handler provides methods for handling different types of tokens without having to check their type.

Author:

Andreas Holstenson

Constructor Summary

Constructors

Constructor and Description
DefaultHandler()

Method Summary

Modifier and Type	Method and Description
void	done() Indicates that there are no more events to process.
void	endAttribute(Location location, TokenProperty<?> property) An attribute has been cleared.
void	endParagraph(Location location) A paragraph has ended.
void	endSentence(Location location) The end of a sentence has been found.
protected void	special(Token token) Special token has been found.
void	start() Processing is starting.
void	startAttribute(Location location, TokenProperty<?> property, Object value) An attribute has been set by the source.
void	startParagraph(Location location) A new paragraph has been started.
void	startSentence(Location location) The start of a sentence has been found.
protected void	symbol(Token token) A sequence of one or more symbols has been found in a sentence.
void	token(Token token) Token has been found, can either be whitespace, symbol or word.
protected void	unknown(Token token) Unknown token has been found, uncommon case as most language implementations will not emit unknown tokens.
protected void	whitespace(Token token) Whitespace either within our outside a sentence.
protected void	word(Token token) A word has been found in a sentence.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHandler

public DefaultHandler()

Method Detail

start

public void start()

Description copied from interface: Handler

Processing is starting.

Specified by:

start in interface Handler

startParagraph

public void startParagraph(Location location)

Description copied from interface: Handler

A new paragraph has been started.

Specified by:

startParagraph in interface Handler

Parameters:

location - the location of the paragraph. Locations are shared, the user should copy the location if it needs to be used outside the current method.

endParagraph

public void endParagraph(Location location)

Description copied from interface: Handler

A paragraph has ended.

Specified by:

endParagraph in interface Handler

Parameters:

location - the location of the paragraph end. Locations are shared, the user should copy the location if it needs to be used outside the current method.

startSentence

public void startSentence(Location location)

Description copied from interface: Handler

The start of a sentence has been found.

Specified by:

startSentence in interface Handler

Parameters:

location - the location of the sentence. Locations are shared, the user should copy the location if it needs to be used outside the current method.

endSentence

public void endSentence(Location location)

Description copied from interface: Handler

The end of a sentence has been found.

Specified by:

endSentence in interface Handler

Parameters:

location - the location of the sentence end. Locations are shared, the user should copy the location if it needs to be used outside the current method.

startAttribute

public void startAttribute(Location location,
                           TokenProperty<?> property,
                           Object value)

Description copied from interface: Handler

An attribute has been set by the source.

Specified by:

startAttribute in interface Handler

Parameters:

location - the location where the property is started. Locations are shared, the user should copy the location if it needs to be used outside the current method.

property - the property to set

value - the value of the property

endAttribute

public void endAttribute(Location location,
                         TokenProperty<?> property)

Description copied from interface: Handler

An attribute has been cleared.

Specified by:

endAttribute in interface Handler

Parameters:

location - the location where the property is ended. Locations are shared, the user should copy the location if it needs to be used outside the current method.

token

public void token(Token token)

Description copied from interface: Handler

Token has been found, can either be whitespace, symbol or word.

Specified by:

token in interface Handler

Parameters:

token - the token that has been found. Tokens are shared and should be copied via Token.copy() if they need to be used outside of the current method.

done

public void done()

Description copied from interface: Handler

Indicates that there are no more events to process.

Specified by:

done in interface Handler

word

protected void word(Token token)

A word has been found in a sentence. Tokens should be copied if their contents should outlive the scope of this method.

Parameters:

token - the token representing the word.

symbol

protected void symbol(Token token)

A sequence of one or more symbols has been found in a sentence. Tokens should be copied if their contents should outlive the scope of this method.

Parameters:

token - the token representing the symbol.

whitespace

protected void whitespace(Token token)

Whitespace either within our outside a sentence. Tokens should be copied if their contents should outlive the scope of this method.

Parameters:

token -

special

protected void special(Token token)

Special token has been found. Tokens should be copied if their contents should outlive the scope of this method.

Parameters:

token -

unknown

protected void unknown(Token token)

Unknown token has been found, uncommon case as most language implementations will not emit unknown tokens. Tokens should be copied if their contents should outlive the scope of this method.