net.mdatools.modelant.core.util

Class NameTokenizer

java.lang.Object

net.mdatools.modelant.core.util.NameTokenizer

All Implemented Interfaces:

Iterator<String>

public class NameTokenizer
extends Object
implements Iterator<String>

This class is a parser of identifiers used to split them into a sequence of words that they are composed of. The words are identified when they are terminated by non-alphanumeric characters or by changing the letter's case. It is useful when parsing the words that are included in for example in Java identifiers. This class will parse its name NameTokenizer into 2 words: "Name" and "Tokenizer". The words identified start with a letter and contain letter of digit. Any non-alphanumeric characters are skipped and used only to terminate words. No empty words are identified. Rules to identify words:

• Words can consist all of lower case letters
• Words can start with 1 upper case letter and continue in lower case
• Words starting with more than 1 upper case letter are split into two words:
  • a word all in upper case
  • a next word starting with exactly one letter in upper case and all other in lower case (at least one exists)
• Words that contain digits are terminated before the first non-digit letter after the digits
• Any leading digits are skipped

Author:

rpopov

Constructor Summary

Constructors

Constructor and Description
NameTokenizer(String source) This is the only constructor of the name tokenizer - it prepares it for parsing the source string/identifier.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() This method checks if there is a following word identified.
String	next() This method returns the next word identified if one exists.
void	remove() This method removes the word just retrieved by next().

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

NameTokenizer

public NameTokenizer(String source)

This is the only constructor of the name tokenizer - it prepares it for parsing the source string/identifier.

Parameters:

source - is the identifier or general text to be parsed

Method Detail

remove

public void remove()

This method removes the word just retrieved by next(). Its usage in the context of this class seems to be obsolete. It is provided for completeness.

Specified by:

remove in interface Iterator<String>

See Also:

Iterator.remove()

hasNext

public boolean hasNext()

This method checks if there is a following word identified.

Specified by:

hasNext in interface Iterator<String>

Returns:

true is one exists

See Also:

Iterator.hasNext()

next

public String next()

This method returns the next word identified if one exists. The object it returns is a string.

Specified by:

next in interface Iterator<String>

Returns:

a string representing the next word identified

See Also:

Iterator.next()