Package org.passay.dictionary

Class AbstractWordList

java.lang.Object

org.passay.dictionary.AbstractWordList

All Implemented Interfaces:

WordList

Direct Known Subclasses:

AbstractFileWordList, ArrayWordList

public abstract class AbstractWordList
extends Object
implements WordList

Provides common operations implementations for word lists.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AbstractWordList.WordListIterator	An iterator over the WordList.

Field Summary

Fields

Modifier and Type	Field	Description
protected Comparator<CharSequence>	comparator	Word comparator.

Constructor Summary

Constructors

Constructor	Description
AbstractWordList()

Method Summary

Modifier and Type	Method	Description
protected void	checkRange(int index)	Throws an IndexOutOfBoundsException if the supplied index is less than 0 or greater than or equal to the size of this word list.
Comparator<CharSequence>	getComparator()	Returns the comparator that should be used to compare a search term with candidate words in the list.
Iterator<String>	iterator()	Returns an iterator to traverse this word list from the 0th index.
Iterator<String>	medianIterator()	Returns an iterator to traverse this word list by following a recursive sequence of medians.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.passay.dictionary.WordList

get, size

Field Details

comparator

protected Comparator<CharSequence> comparator

Word comparator.

Constructor Details

AbstractWordList

public AbstractWordList()

Method Details

getComparator

public Comparator<CharSequence> getComparator()

Description copied from interface: WordList

Returns the comparator that should be used to compare a search term with candidate words in the list. The comparator naturally respects ordering and case sensitivity of the word list.

Specified by:

getComparator in interface WordList

Returns:

comparator for words in the list.

iterator

public Iterator<String> iterator()

Description copied from interface: WordList

Returns an iterator to traverse this word list from the 0th index.

Specified by:

iterator in interface WordList

Returns:

iterator for this word list

medianIterator

public Iterator<String> medianIterator()

Description copied from interface: WordList

Returns an iterator to traverse this word list by following a recursive sequence of medians.

Specified by:

medianIterator in interface WordList

Returns:

iterator for this word list

checkRange

protected void checkRange(int index)

Throws an IndexOutOfBoundsException if the supplied index is less than 0 or greater than or equal to the size of this word list.

Parameters:

index - to check