de.susebox.jtopas

Class AbstractTokenizerProperties

java.lang.Object

de.susebox.jtopas.AbstractTokenizerProperties

All Implemented Interfaces:

TokenizerProperties

Direct Known Subclasses:

StandardTokenizerProperties

public abstract class AbstractTokenizerProperties
extends java.lang.Object
implements TokenizerProperties

The class AbstractTokenizerProperties provides the skeleton for implementations of the TokenizerProperties interface. It leaves only the more general methods to these implementations. For instance, the simple method addKeyword(String) can and should call the more complex method #addKeyword(String, String) with the second parameter null. That method in turn should call #addKeyword(String, String, int) etc.

Author:

Heiko Blau

See Also:

TokenizerProperties, Tokenizer

Field Summary

Fields inherited from interface de.susebox.jtopas.TokenizerProperties

DEFAULT_BLOCK_COMMENT_END, DEFAULT_BLOCK_COMMENT_START, DEFAULT_CHAR_END, DEFAULT_CHAR_ESCAPE, DEFAULT_CHAR_START, DEFAULT_LINE_COMMENT, DEFAULT_SEPARATORS, DEFAULT_STRING_END, DEFAULT_STRING_ESCAPE, DEFAULT_STRING_START, DEFAULT_WHITESPACES

Constructor Summary

Constructors

Constructor and Description
AbstractTokenizerProperties()

Method Summary

Modifier and Type	Method and Description
void	addBlockComment(java.lang.String start, java.lang.String end) Registering a block comment.
void	addBlockComment(java.lang.String start, java.lang.String end, java.lang.Object companion) Registering a block comment.
void	addBlockComment(java.lang.String start, java.lang.String end, java.lang.Object companion, int flags) Registering a block comment.
void	addBlockComment(java.lang.String start, java.lang.String end, java.lang.Object companion, int flags, int flagMask) Registering a block comment with a set of flags and an associated flag mask.
void	addKeyword(java.lang.String keyword) Registering a keyword.
void	addKeyword(java.lang.String keyword, java.lang.Object companion) Registering a keyword.
void	addKeyword(java.lang.String keyword, java.lang.Object companion, int flags) Registering a keyword.
void	addKeyword(java.lang.String keyword, java.lang.Object companion, int flags, int flagMask) Registering a keyword with a set of flags and an associated flag mask..
void	addLineComment(java.lang.String lineComment) Registering a the starting sequence of a line comment.
void	addLineComment(java.lang.String lineComment, java.lang.Object companion) Registering a the starting sequence of a line comment.
void	addLineComment(java.lang.String lineComment, java.lang.Object companion, int flags) Registering a the starting sequence of a line comment.
void	addLineComment(java.lang.String lineComment, java.lang.Object companion, int flags, int flagMask) Registering a line comment with a set of flags and an associated flag mask.
void	addPattern(java.lang.String pattern) Registering a pattern.
void	addPattern(java.lang.String pattern, java.lang.Object companion) Registering a pattern with an associated object.
void	addPattern(java.lang.String pattern, java.lang.Object companion, int flags) Registering a pattern with an associated object.
void	addPattern(java.lang.String pattern, java.lang.Object companion, int flags, int flagMask) Registering a pattern with an associated object and explicitely given flags.
void	addProperty(TokenizerProperty property) Registering a TokenizerProperty.
void	addSeparators(java.lang.String separators) Adding new separators to the existing set.
void	addSpecialSequence(java.lang.String specSeq) Registering a special sequence of characters.
void	addSpecialSequence(java.lang.String specSeq, java.lang.Object companion) Registering a special sequence of characters.
void	addSpecialSequence(java.lang.String specSeq, java.lang.Object companion, int flags) Registering a special sequence of characters.
void	addSpecialSequence(java.lang.String specSeq, java.lang.Object companion, int flags, int flagMask) Registering a special sequence with a set of flags and an associated flag mask.
void	addString(java.lang.String start, java.lang.String end, java.lang.String escape) Registering a string description.
void	addString(java.lang.String start, java.lang.String end, java.lang.String escape, java.lang.Object companion) Registering a the sequences that are used for string-like text parts.
void	addString(java.lang.String start, java.lang.String end, java.lang.String escape, java.lang.Object companion, int flags) Registering a the sequences that are used for string-like text parts.
void	addString(java.lang.String start, java.lang.String end, java.lang.String escape, java.lang.Object companion, int flags, int flagMask) Registering a string with a set of flags and an associated flag mask.
void	addTokenizerPropertyListener(TokenizerPropertyListener listener) Registering a new TokenizerPropertyListener.
void	addWhitespaces(java.lang.String whitespaces) Adding new whitespaces to the existing set.
boolean	blockCommentExists(java.lang.String start) Checks if the given block comment is known.
TokenizerProperty	getBlockComment(java.lang.String start) Get the full description of a block comment property.
java.lang.Object	getBlockCommentCompanion(java.lang.String start) Retrieving a certain block comment.
TokenizerProperty	getKeyword(java.lang.String keyword) Get the full description of a keyword property.
java.lang.Object	getKeywordCompanion(java.lang.String keyword) Retrieving the companion of the given keyword.
TokenizerProperty	getLineComment(java.lang.String lineComment) Get the full description of a line comment property.
java.lang.Object	getLineCommentCompanion(java.lang.String lineComment) Retrieving the associated object of a certain line comment.
int	getParseFlags() See the method description in TokenizerProperties.
TokenizerProperty	getPattern(java.lang.String pattern) Get the full description of a string property starting with the given prefix.
java.lang.Object	getPatternCompanion(java.lang.String pattern) Retrieving the information associated with a given pattern.
TokenizerProperty	getSpecialSequence(java.lang.String specSeq) Get the full description of a special sequence property.
java.lang.Object	getSpecialSequenceCompanion(java.lang.String specSeq) Retrieving the companion of the given special sequence.
TokenizerProperty	getString(java.lang.String start) Get the full description of a string property.
java.lang.Object	getStringCompanion(java.lang.String start) Retrieving the information associated with a certain string.
boolean	isFlagSet(int flag) Returns true if a given flag is set in the current parse flags.
boolean	isFlagSet(TokenizerProperty prop, int flag) Checks if a given flag (see the constants in Flags) is set for the given TokenizerProperty in the context of this TokenizerProperties instance.
boolean	keywordExists(java.lang.String keyword) Checks if the given keyword is known to the Tokenizer.
boolean	lineCommentExists(java.lang.String lineComment) Checks if the give line comment is known.
boolean	patternExists(java.lang.String pattern) Checks if the given pattern is known to the parser.
boolean	propertyExists(TokenizerProperty property) Checks if the given TokenizerProperty is known.
void	removeBlockComment(java.lang.String start) Removing a certain block comment.
void	removeKeyword(java.lang.String keyword) Deregistering a keyword.
void	removeLineComment(java.lang.String lineComment) Removing a certain line comment.
void	removePattern(java.lang.String pattern) Removing a pattern.
void	removeProperty(TokenizerProperty property) Deregistering a TokenizerProperty from the store.
void	removeSeparators(java.lang.String separators) Removing separators from the existing set.
void	removeSpecialSequence(java.lang.String specSeq) Deregistering a special sequence from the parser.
void	removeString(java.lang.String start) Removing a string description.
void	removeTokenizerPropertyListener(TokenizerPropertyListener listener) Removing a listener from the list of registered TokenizerPropertyListener instances.
void	removeWhitespaces(java.lang.String whitespaces) Removing whitespaces from the existing set.
void	setParseFlags(int flags) See the method description in TokenizerProperties.
void	setSeparators(java.lang.String separators) Setting the separator character set of the tokenizer.
void	setWhitespaces(java.lang.String whitespaces) Setting the whitespace character set of the tokenizer.
boolean	specialSequenceExists(java.lang.String specSeq) Checks if the given special sequence is known to the Tokenizer.
boolean	stringExists(java.lang.String start) Checks if the given starting sequence of the string is known to the parser.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.susebox.jtopas.TokenizerProperties

getBlockComments, getKeywords, getLineComments, getPatterns, getProperties, getSeparators, getSpecialSequences, getStrings, getWhitespaces

Constructor Detail

AbstractTokenizerProperties

public AbstractTokenizerProperties()

Method Detail

setParseFlags

public void setParseFlags(int flags)

See the method description in TokenizerProperties.

Specified by:

setParseFlags in interface TokenizerProperties

Parameters:

flags - the parser control flags

See Also:

getParseFlags()

getParseFlags

public int getParseFlags()

See the method description in TokenizerProperties.

Specified by:

getParseFlags in interface TokenizerProperties

Returns:

the current parser control flags

See Also:

setParseFlags(int)

isFlagSet

public boolean isFlagSet(int flag)

Returns true if a given flag is set in the current parse flags. If the parameter contains more than one bit the method returns only true if all bits are set.

Specified by:

isFlagSet in interface TokenizerProperties

Parameters:

flag - the flag to test

Returns:

true if all bits in flag are set.

See Also:

setParseFlags(int)

isFlagSet

public boolean isFlagSet(TokenizerProperty prop,
                         int flag)
                  throws java.lang.NullPointerException

Checks if a given flag (see the constants in Flags) is set for the given TokenizerProperty in the context of this TokenizerProperties instance.

Specified by:

isFlagSet in interface TokenizerProperties

Parameters:

prop - the TokenizerProperty concerned

flag - the flag to check (may contain more than one bit)

Returns:

true if the flag is set either explicit in the property or globally for this TokenizerProperties object, false otherwise

Throws:

java.lang.NullPointerException - if no property is given

setWhitespaces

public void setWhitespaces(java.lang.String whitespaces)

Setting the whitespace character set of the tokenizer. See the method description in TokenizerProperties.
This method calls the abstract method doSetWhitespaces(java.lang.String). It guaranties that the parameter passed to doSetWhitespaces is not null (instead empty) and uppercase if the Flag Flags.F_NO_CASE is set.

Specified by:

setWhitespaces in interface TokenizerProperties

Parameters:

whitespaces - the whitespace set

See Also:

TokenizerProperties.getWhitespaces(), TokenizerProperties.addWhitespaces(java.lang.String), TokenizerProperties.removeWhitespaces(java.lang.String)

addWhitespaces

public void addWhitespaces(java.lang.String whitespaces)
                    throws java.lang.IllegalArgumentException

Adding new whitespaces to the existing set.

Specified by:

addWhitespaces in interface TokenizerProperties

Parameters:

additional - whitespaces for the whitespace set

Throws:

java.lang.IllegalArgumentException - when null is passed or incomplete ranges are specified (e.g. "a-")

See Also:

TokenizerProperties.getWhitespaces(), TokenizerProperties.setWhitespaces(java.lang.String), TokenizerProperties.removeWhitespaces(java.lang.String)

removeWhitespaces

public void removeWhitespaces(java.lang.String whitespaces)
                       throws java.lang.IllegalArgumentException

Removing whitespaces from the existing set.

Specified by:

removeWhitespaces in interface TokenizerProperties

Parameters:

whitespaces - whitespaces to remove from the whitespace set

Throws:

java.lang.IllegalArgumentException - when null is passed or incomplete ranges are specified (e.g. "a-")

See Also:

TokenizerProperties.getWhitespaces(), TokenizerProperties.setWhitespaces(java.lang.String), TokenizerProperties.addWhitespaces(java.lang.String)

setSeparators

public void setSeparators(java.lang.String separators)

Setting the separator character set of the tokenizer. See the method description in TokenizerProperties.
This method calls the abstract method doSetSeparators(java.lang.String). It guaranties that the parameter passed to doSetSeparators is not null (instead empty) and uppercase if the Flag Flags.F_NO_CASE is set.

Specified by:

setSeparators in interface TokenizerProperties

Parameters:

separators - the separator set

See Also:

TokenizerProperties.getSeparators()

addSeparators

public void addSeparators(java.lang.String separators)
                   throws java.lang.IllegalArgumentException

Adding new separators to the existing set.

Specified by:

addSeparators in interface TokenizerProperties

Parameters:

separators - additional separators for the separator set

Throws:

java.lang.IllegalArgumentException - when null is passed or incomplete ranges are specified (e.g. "a-")

See Also:

TokenizerProperties.getSeparators(), TokenizerProperties.setSeparators(java.lang.String), TokenizerProperties.removeSeparators(java.lang.String)

removeSeparators

public void removeSeparators(java.lang.String separators)
                      throws java.lang.IllegalArgumentException

Removing separators from the existing set.

Specified by:

removeSeparators in interface TokenizerProperties

Parameters:

separators - separating characters to remove from the separator set

Throws:

java.lang.IllegalArgumentException - when null is passed or incomplete ranges are specified (e.g. "a-")

See Also:

TokenizerProperties.getSeparators(), TokenizerProperties.setSeparators(java.lang.String), TokenizerProperties.addSeparators(java.lang.String)

addString

public void addString(java.lang.String start,
                      java.lang.String end,
                      java.lang.String escape)
               throws java.lang.IllegalArgumentException

Registering a string description. See the method description in the interface TokenizerProperties.

Specified by:

addString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

end - the finishing sequence of a string

escape - the escape sequence inside the string

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start or end

See Also:

removeString(java.lang.String), addString(String, String, String, Object)

addString

public void addString(java.lang.String start,
                      java.lang.String end,
                      java.lang.String escape,
                      java.lang.Object companion)
               throws java.lang.IllegalArgumentException

Registering a the sequences that are used for string-like text parts. See the method description in TokenizerProperties.

Specified by:

addString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

end - the finishing sequence of a string

escape - the escape sequence inside the string

companion - the associated information

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start or end

See Also:

TokenizerProperties.addString(String, String, String), TokenizerProperties.addString(String, String, String, Object, int), TokenizerProperties.removeString(java.lang.String)

addString

public void addString(java.lang.String start,
                      java.lang.String end,
                      java.lang.String escape,
                      java.lang.Object companion,
                      int flags)
               throws java.lang.IllegalArgumentException

Registering a the sequences that are used for string-like text parts. See the method description in TokenizerProperties.

Specified by:

addString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

end - the finishing sequence of a string

escape - the escape sequence inside the string

companion - the associated information

flags - modification flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start or end

See Also:

TokenizerProperties.addString(String, String, String), TokenizerProperties.addString(String, String, String, Object), TokenizerProperties.addString(String, String, String, Object, int, int), TokenizerProperties.removeString(java.lang.String)

addString

public void addString(java.lang.String start,
                      java.lang.String end,
                      java.lang.String escape,
                      java.lang.Object companion,
                      int flags,
                      int flagMask)
               throws java.lang.IllegalArgumentException

Registering a string with a set of flags and an associated flag mask.

Specified by:

addString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

end - the finishing sequence of a string

escape - the escape sequence inside the string

companion - the associated information

flags - modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for keyword

See Also:

TokenizerProperties.addString(String, String, String), TokenizerProperties.addString(String, String, String, Object), TokenizerProperties.addString(String, String, String, Object, int), TokenizerProperties.removeString(java.lang.String)

removeString

public void removeString(java.lang.String start)
                  throws java.lang.IllegalArgumentException

Removing a string description. See the method description in TokenizerProperties.

Specified by:

removeString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start

getStringCompanion

public java.lang.Object getStringCompanion(java.lang.String start)
                                    throws java.lang.IllegalArgumentException

Retrieving the information associated with a certain string. See the method description in TokenizerProperties.

Specified by:

getStringCompanion in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

Returns:

the associated information or null

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start

stringExists

public boolean stringExists(java.lang.String start)

Checks if the given starting sequence of the string is known to the parser. See the method description in TokenizerProperties.

Specified by:

stringExists in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

Returns:

true if the string is registered, false otherwise

getString

public TokenizerProperty getString(java.lang.String start)
                            throws java.lang.IllegalArgumentException

Get the full description of a string property. See the method description in TokenizerProperties.

Specified by:

getString in interface TokenizerProperties

Parameters:

start - the starting sequence of a string

Returns:

the full string description or null

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

addLineComment

public void addLineComment(java.lang.String lineComment)
                    throws java.lang.IllegalArgumentException

Registering a the starting sequence of a line comment. See the method description in TokenizerProperties.

Specified by:

addLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of the line comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the line comment

See Also:

TokenizerProperties.addLineComment(String, Object), TokenizerProperties.addLineComment(String, Object, int), TokenizerProperties.removeLineComment(java.lang.String)

addLineComment

public void addLineComment(java.lang.String lineComment,
                           java.lang.Object companion)
                    throws java.lang.IllegalArgumentException

Registering a the starting sequence of a line comment. See the method description in TokenizerProperties.

Specified by:

addLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of a line comment

companion - the associated information

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the line comment

See Also:

TokenizerProperties.addLineComment(String), TokenizerProperties.addLineComment(String, Object, int), TokenizerProperties.removeLineComment(java.lang.String)

addLineComment

public void addLineComment(java.lang.String lineComment,
                           java.lang.Object companion,
                           int flags)
                    throws java.lang.IllegalArgumentException

Registering a the starting sequence of a line comment. See the method description in TokenizerProperties.

Specified by:

addLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of a line comment

companion - the associated information

flags - modification flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the line comment

See Also:

TokenizerProperties.addLineComment(String), TokenizerProperties.addLineComment(String, Object), TokenizerProperties.addLineComment(String, Object, int, int), TokenizerProperties.removeLineComment(java.lang.String)

addLineComment

public void addLineComment(java.lang.String lineComment,
                           java.lang.Object companion,
                           int flags,
                           int flagMask)
                    throws java.lang.IllegalArgumentException

Registering a line comment with a set of flags and an associated flag mask.

Specified by:

addLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of a line comment

companion - the associated information

flags - modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for keyword

See Also:

TokenizerProperties.addLineComment(String), TokenizerProperties.addLineComment(String, Object), TokenizerProperties.addLineComment(String, Object, int), TokenizerProperties.removeLineComment(java.lang.String)

removeLineComment

public void removeLineComment(java.lang.String lineComment)
                       throws java.lang.IllegalArgumentException

Removing a certain line comment. See the method description in TokenizerProperties.

Specified by:

removeLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of the line comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the line comment

See Also:

TokenizerProperties.addLineComment(String), TokenizerProperties.addLineComment(String, Object), TokenizerProperties.addLineComment(String, Object, int)

getLineCommentCompanion

public java.lang.Object getLineCommentCompanion(java.lang.String lineComment)
                                         throws java.lang.IllegalArgumentException

Retrieving the associated object of a certain line comment. See the method description in TokenizerProperties.

Specified by:

getLineCommentCompanion in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of the line comment

Returns:

the object associated with the line comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the line comment

See Also:

TokenizerProperties.lineCommentExists(java.lang.String)

lineCommentExists

public boolean lineCommentExists(java.lang.String lineComment)

Checks if the give line comment is known. See the method description in TokenizerProperties.

Specified by:

lineCommentExists in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of the line comment

Returns:

true if the line comment is known, false otherwise

getLineComment

public TokenizerProperty getLineComment(java.lang.String lineComment)
                                 throws java.lang.IllegalArgumentException

Get the full description of a line comment property. See the method description in TokenizerProperties.

Specified by:

getLineComment in interface TokenizerProperties

Parameters:

lineComment - the starting sequence of the line comment

Returns:

the full line comment description or null

Throws:

java.lang.IllegalArgumentException - if the given image is empty or null

See Also:

TokenizerProperties.lineCommentExists(java.lang.String)

addBlockComment

public void addBlockComment(java.lang.String start,
                            java.lang.String end)
                     throws java.lang.IllegalArgumentException

Registering a block comment. See the method description in TokenizerProperties.

Specified by:

addBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

end - the finishing sequence of the block comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start / end sequence of the block comment

See Also:

TokenizerProperties.addBlockComment(String, String, Object), TokenizerProperties.addBlockComment(String, String, Object, int), TokenizerProperties.removeBlockComment(java.lang.String)

addBlockComment

public void addBlockComment(java.lang.String start,
                            java.lang.String end,
                            java.lang.Object companion)
                     throws java.lang.IllegalArgumentException

Registering a block comment. See the method description in TokenizerProperties.

Specified by:

addBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

end - the finishing sequence of the block comment

companion - information object associated with this block comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start / end sequence of the block comment

See Also:

TokenizerProperties.addBlockComment(String, String), TokenizerProperties.addBlockComment(String, String, Object, int), TokenizerProperties.removeBlockComment(java.lang.String)

addBlockComment

public void addBlockComment(java.lang.String start,
                            java.lang.String end,
                            java.lang.Object companion,
                            int flags)
                     throws java.lang.IllegalArgumentException

Registering a block comment. See the method description in TokenizerProperties.

Specified by:

addBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

end - the finishing sequence of the block comment

companion - information object associated with this block comment

flags - modification flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start / end sequence of the block comment

See Also:

TokenizerProperties.addBlockComment(String, String), TokenizerProperties.addBlockComment(String, String, Object), TokenizerProperties.addBlockComment(String, String, Object, int, int), TokenizerProperties.removeBlockComment(java.lang.String)

addBlockComment

public void addBlockComment(java.lang.String start,
                            java.lang.String end,
                            java.lang.Object companion,
                            int flags,
                            int flagMask)
                     throws java.lang.IllegalArgumentException

Registering a block comment with a set of flags and an associated flag mask.

Specified by:

addBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

end - the finishing sequence of the block comment

companion - information object associated with this block comment

flags - modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for keyword

See Also:

TokenizerProperties.addBlockComment(String, String), TokenizerProperties.addBlockComment(String, String, Object), TokenizerProperties.addBlockComment(String, String, Object, int), TokenizerProperties.removeBlockComment(java.lang.String)

removeBlockComment

public void removeBlockComment(java.lang.String start)
                        throws java.lang.IllegalArgumentException

Removing a certain block comment. See the method description in TokenizerProperties.

Specified by:

removeBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the block comment

getBlockCommentCompanion

public java.lang.Object getBlockCommentCompanion(java.lang.String start)
                                          throws java.lang.IllegalArgumentException

Retrieving a certain block comment. See the method description in TokenizerProperties.

Specified by:

getBlockCommentCompanion in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

Returns:

the associated object of the block comment

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for start sequence of the block comment

blockCommentExists

public boolean blockCommentExists(java.lang.String start)

Checks if the given block comment is known. See the method description in TokenizerProperties.

Specified by:

blockCommentExists in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

Returns:

true if the block comment is known, false otherwise

getBlockComment

public TokenizerProperty getBlockComment(java.lang.String start)
                                  throws java.lang.IllegalArgumentException

Get the full description of a block comment property. See the method description in TokenizerProperties.

Specified by:

getBlockComment in interface TokenizerProperties

Parameters:

start - the starting sequence of the block comment

Returns:

the full block comment description or null

Throws:

java.lang.IllegalArgumentException - if the given image is empty or null

addSpecialSequence

public void addSpecialSequence(java.lang.String specSeq)
                        throws java.lang.IllegalArgumentException

Registering a special sequence of characters. See the method description in TokenizerProperties.

Specified by:

addSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - special sequence to register

Throws:

java.lang.IllegalArgumentException - if the given sequence is empty or null

See Also:

addKeyword(java.lang.String), setSeparators(java.lang.String)

addSpecialSequence

public void addSpecialSequence(java.lang.String specSeq,
                               java.lang.Object companion)
                        throws java.lang.IllegalArgumentException

Registering a special sequence of characters. See the method description in TokenizerProperties.

Specified by:

addSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - special sequence to register

companion - information object associated with this special sequence

Throws:

java.lang.IllegalArgumentException - if the given sequence is empty or null

See Also:

addKeyword(java.lang.String), setSeparators(java.lang.String)

addSpecialSequence

public void addSpecialSequence(java.lang.String specSeq,
                               java.lang.Object companion,
                               int flags)
                        throws java.lang.IllegalArgumentException

Registering a special sequence of characters. See the method description in TokenizerProperties.

Specified by:

addSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - special sequence to register

companion - information object associated with this special sequence

flags - modification flags

Throws:

java.lang.IllegalArgumentException - if the given sequence is empty or null

See Also:

addKeyword(java.lang.String), setSeparators(java.lang.String)

addSpecialSequence

public void addSpecialSequence(java.lang.String specSeq,
                               java.lang.Object companion,
                               int flags,
                               int flagMask)
                        throws java.lang.IllegalArgumentException

Registering a special sequence with a set of flags and an associated flag mask.

Specified by:

addSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - special sequence to register

companion - information object associated with this special sequence

flags - modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for keyword

See Also:

TokenizerProperties.addSpecialSequence(String), TokenizerProperties.addSpecialSequence(String, Object), TokenizerProperties.addSpecialSequence(String, Object, int), TokenizerProperties.removeSpecialSequence(java.lang.String)

removeSpecialSequence

public void removeSpecialSequence(java.lang.String specSeq)
                           throws java.lang.IllegalArgumentException

Deregistering a special sequence from the parser. See the method description in TokenizerProperties.

Specified by:

removeSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - sequence to remove

Throws:

java.lang.IllegalArgumentException - if the given sequence is empty or null

See Also:

TokenizerProperties.addSpecialSequence(String), TokenizerProperties.addSpecialSequence(String, Object), TokenizerProperties.addSpecialSequence(String, Object, int)

getSpecialSequenceCompanion

public java.lang.Object getSpecialSequenceCompanion(java.lang.String specSeq)
                                             throws java.lang.IllegalArgumentException

Retrieving the companion of the given special sequence. See the method description in TokenizerProperties.

Specified by:

getSpecialSequenceCompanion in interface TokenizerProperties

Parameters:

specSeq - sequence to remove

Returns:

the object associated with the special sequence

Throws:

java.lang.IllegalArgumentException - if the given sequence is empty or null

specialSequenceExists

public boolean specialSequenceExists(java.lang.String specSeq)

Checks if the given special sequence is known to the Tokenizer. See the method description in TokenizerProperties.

Specified by:

specialSequenceExists in interface TokenizerProperties

Parameters:

specSeq - sequence to check

Returns:

true if the block comment is known, false otherwise

getSpecialSequence

public TokenizerProperty getSpecialSequence(java.lang.String specSeq)
                                     throws java.lang.IllegalArgumentException

Get the full description of a special sequence property. See the method description in TokenizerProperties.

Specified by:

getSpecialSequence in interface TokenizerProperties

Parameters:

specSeq - sequence to search

Returns:

the full sequence description or null

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

addKeyword

public void addKeyword(java.lang.String keyword)
                throws java.lang.IllegalArgumentException

Registering a keyword. See the method description in TokenizerProperties.

Specified by:

addKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to register

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

See Also:

TokenizerProperties.addKeyword(String, Object), TokenizerProperties.addKeyword(String, Object, int), TokenizerProperties.removeKeyword(java.lang.String)

addKeyword

public void addKeyword(java.lang.String keyword,
                       java.lang.Object companion)
                throws java.lang.IllegalArgumentException

Registering a keyword. See the method description in TokenizerProperties.

Specified by:

addKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to register

companion - information object associated with this keyword

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

See Also:

TokenizerProperties.addKeyword(String), TokenizerProperties.addKeyword(String, Object, int), TokenizerProperties.removeKeyword(java.lang.String)

addKeyword

public void addKeyword(java.lang.String keyword,
                       java.lang.Object companion,
                       int flags)
                throws java.lang.IllegalArgumentException

Registering a keyword. See the method description in TokenizerProperties.

Specified by:

addKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to register

companion - information object associated with this keyword

flags - modification flags

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

See Also:

TokenizerProperties.addKeyword(String), TokenizerProperties.addKeyword(String, Object), TokenizerProperties.removeKeyword(java.lang.String)

addKeyword

public void addKeyword(java.lang.String keyword,
                       java.lang.Object companion,
                       int flags,
                       int flagMask)
                throws java.lang.IllegalArgumentException

Registering a keyword with a set of flags and an associated flag mask..

Specified by:

addKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to register

companion - information object associated with this keyword

flags - modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed for keyword

See Also:

TokenizerProperties.addKeyword(String), TokenizerProperties.addKeyword(String, Object), TokenizerProperties.removeKeyword(java.lang.String)

removeKeyword

public void removeKeyword(java.lang.String keyword)
                   throws java.lang.IllegalArgumentException

Deregistering a keyword. See the method description in TokenizerProperties.

Specified by:

removeKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to remove

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

See Also:

TokenizerProperties.addKeyword(String), TokenizerProperties.addKeyword(String, Object), TokenizerProperties.addKeyword(String, Object, int)

getKeywordCompanion

public java.lang.Object getKeywordCompanion(java.lang.String keyword)
                                     throws java.lang.IllegalArgumentException

Retrieving the companion of the given keyword. See the method description in TokenizerProperties.

Specified by:

getKeywordCompanion in interface TokenizerProperties

Parameters:

keyword - keyword thats companion is sought

Returns:

the object associated with the keyword

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

keywordExists

public boolean keywordExists(java.lang.String keyword)

Checks if the given keyword is known to the Tokenizer. See the method description in TokenizerProperties.

Specified by:

keywordExists in interface TokenizerProperties

Parameters:

keyword - keyword to search

Returns:

true if the keyword is known, false otherwise

getKeyword

public TokenizerProperty getKeyword(java.lang.String keyword)
                             throws java.lang.IllegalArgumentException

Get the full description of a keyword property. See the method description in TokenizerProperties.

Specified by:

getKeyword in interface TokenizerProperties

Parameters:

keyword - keyword to search

Returns:

the full keyword description or null

Throws:

java.lang.IllegalArgumentException - if the given keyword is empty or null

addPattern

public void addPattern(java.lang.String pattern)
                throws java.lang.IllegalArgumentException

Registering a pattern. See the method description in TokenizerProperties.

Specified by:

addPattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be added

Throws:

java.lang.IllegalArgumentException - when null or an empty pattern is passed

See Also:

removePattern(java.lang.String), addPattern(String, Object), addPattern(String, Object, int)

addPattern

public void addPattern(java.lang.String pattern,
                       java.lang.Object companion)
                throws java.lang.IllegalArgumentException

Registering a pattern with an associated object. See the method description in TokenizerProperties.

Specified by:

addPattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be added

companion - information object associated with this pattern

Throws:

java.lang.IllegalArgumentException - when null or an empty pattern is passed

See Also:

removePattern(java.lang.String), addPattern(String), addPattern(String, Object, int)

addPattern

public void addPattern(java.lang.String pattern,
                       java.lang.Object companion,
                       int flags)
                throws java.lang.IllegalArgumentException

Registering a pattern with an associated object. See the method description in TokenizerProperties.

Specified by:

addPattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be added

companion - information object associated with this keyword

flags - modification flags

Throws:

java.lang.IllegalArgumentException - when null or an empty pattern is passed

See Also:

removePattern(java.lang.String), addPattern(String), addPattern(String, Object)

addPattern

public void addPattern(java.lang.String pattern,
                       java.lang.Object companion,
                       int flags,
                       int flagMask)
                throws java.lang.IllegalArgumentException

Registering a pattern with an associated object and explicitely given flags. See the description of the addPattern(String) for details on pattern.

Specified by:

addPattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be added

companion - information object associated with this keyword

flags - values for modification flags

flagMask - flags that have valid values in the parameter flags

Throws:

java.lang.IllegalArgumentException - when null or an empty pattern is passed

See Also:

TokenizerProperties.removePattern(java.lang.String), TokenizerProperties.addPattern(String), TokenizerProperties.addPattern(String, Object), TokenizerProperties.addPattern(String, Object, int)

removePattern

public void removePattern(java.lang.String pattern)
                   throws java.lang.IllegalArgumentException

Removing a pattern. See the method description in TokenizerProperties.

Specified by:

removePattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be removed

Throws:

java.lang.IllegalArgumentException - when null or an empty string is passed

getPatternCompanion

public java.lang.Object getPatternCompanion(java.lang.String pattern)
                                     throws java.lang.IllegalArgumentException

Retrieving the information associated with a given pattern. See the method description in TokenizerProperties.

Specified by:

getPatternCompanion in interface TokenizerProperties

Parameters:

pattern - the regular expression to be removed

Returns:

the associated information or null

Throws:

java.lang.IllegalArgumentException - when null or an emtpy pattern is passed

patternExists

public boolean patternExists(java.lang.String pattern)

Checks if the given pattern is known to the parser. See the method description in TokenizerProperties.

Specified by:

patternExists in interface TokenizerProperties

Parameters:

pattern - the regular expression to be looked for

Returns:

true if the pattern is registered, false otherwise

getPattern

public TokenizerProperty getPattern(java.lang.String pattern)
                             throws java.lang.IllegalArgumentException

Get the full description of a string property starting with the given prefix. The method returns null if the passed start parameter cannot be mapped to a known string description (stringExists(java.lang.String) would return false).

Specified by:

getPattern in interface TokenizerProperties

Parameters:

pattern - the regular expression to be looked for

Returns:

the full pattern description or null

Throws:

java.lang.IllegalArgumentException - when null or an emtpy pattern is passed

addProperty

public void addProperty(TokenizerProperty property)
                 throws java.lang.IllegalArgumentException

Registering a TokenizerProperty. See the method description in TokenizerProperties.

Specified by:

addProperty in interface TokenizerProperties

Parameters:

property - property to register

Throws:

java.lang.IllegalArgumentException - when null, an incomplete or otherwise unusable property is passed

removeProperty

public void removeProperty(TokenizerProperty property)
                    throws java.lang.IllegalArgumentException

Deregistering a TokenizerProperty from the store. See the method description in TokenizerProperties.

Specified by:

removeProperty in interface TokenizerProperties

Parameters:

property - property to register

Throws:

java.lang.IllegalArgumentException - when null, an incomplete or otherwise unusable property is passed

propertyExists

public boolean propertyExists(TokenizerProperty property)

Checks if the given TokenizerProperty is known. See the method description in TokenizerProperties.

Specified by:

propertyExists in interface TokenizerProperties

Parameters:

property - the property to search

Returns:

true if the property is known, false otherwise

addTokenizerPropertyListener

public void addTokenizerPropertyListener(TokenizerPropertyListener listener)

Registering a new TokenizerPropertyListener. See the method description in TokenizerProperties.

Specified by:

addTokenizerPropertyListener in interface TokenizerProperties

Parameters:

listener - the new TokenizerPropertyListener

See Also:

removeTokenizerPropertyListener(de.susebox.jtopas.TokenizerPropertyListener)

removeTokenizerPropertyListener

public void removeTokenizerPropertyListener(TokenizerPropertyListener listener)

Removing a listener from the list of registered TokenizerPropertyListener instances. See the method description in TokenizerProperties.

Specified by:

removeTokenizerPropertyListener in interface TokenizerProperties

Parameters:

listener - the TokenizerPropertyListener to deregister

See Also:

addTokenizerPropertyListener(de.susebox.jtopas.TokenizerPropertyListener)