de.susebox.jtopas.spi

Interface WhitespaceHandler

All Known Subinterfaces:

DataMapper

All Known Implementing Classes:

StandardTokenizerProperties, StandardWhitespaceHandler

public interface WhitespaceHandler

This interface declares the methods a Tokenizer needs to deal with whitespaces.

Whitespaces are single characters that separate other tokens. In programming languages, the item whitespace also refers to comments. This does not apply to a WhitespaceHandler that only recognizes single characters. Comments are handled by the SequenceHandler interface.

Author:

Heiko Blau

See Also:

Tokenizer, TokenizerProperties, DataMapper, SequenceHandler

Method Summary

Modifier and Type	Method and Description
int	countLeadingWhitespaces(DataProvider dataProvider) This method detects the number of whitespace characters the data range given through the DataProvider parameter starts with.
boolean	isWhitespace(char testChar) This method checks if the given character is a whitespace.
boolean	newlineIsWhitespace() If a Tokenizer performs line counting, it is often nessecary to know if newline characters (Carriage return and line feed) are (currently) considered to be whitespaces, which is most often the case.

Method Detail

isWhitespace

boolean isWhitespace(char testChar)

This method checks if the given character is a whitespace.

Parameters:

testChar - check this character

Returns:

true if the given character is a whitespace, false otherwise

See Also:

TokenizerProperties.setWhitespaces(java.lang.String)

countLeadingWhitespaces

int countLeadingWhitespaces(DataProvider dataProvider)
                     throws TokenizerException,
                            java.lang.NullPointerException

This method detects the number of whitespace characters the data range given through the DataProvider parameter starts with. An implementation should use a TokenizerException to report problems.

Parameters:

dataProvider - the source to get the data range from

Returns:

number of whitespace characters starting from the given offset

Throws:

TokenizerException - generic exception

java.lang.NullPointerException - if no DataProvider is given

See Also:

DataProvider

newlineIsWhitespace

boolean newlineIsWhitespace()

If a Tokenizer performs line counting, it is often nessecary to know if newline characters (Carriage return and line feed) are (currently) considered to be whitespaces, which is most often the case. This method informs interested callers about the current condition.
Note that this method should return true only if both newline characters are part of the current whitespace set.

Returns:

true if newline characters are in the current whitespace set, false otherwise