com.groupdocs.search.dictionaries

Interface StopWordDictionary

All Superinterfaces:

DictionaryBase, Iterable<String>

public interface StopWordDictionary
extends DictionaryBase, Iterable<String>

Defines interface of a dictionary of stop words.

Learn more

• Indexing with stop words
• Managing stop word dictionary

Method Summary

Modifier and Type	Method and Description
void	addRange(Iterable<String> words) Adds the specified collection of words to this instance of the StopWordDictionary.
void	addRange(String[] words) Adds the specified collection of words to this instance of the StopWordDictionary.
void	clear() Removes all words from a StopWordDictionary object.
boolean	contains(String word) Determines whether a StopWordDictionary object contains the specified word.
int	getCount() Gets the number of stop words contained in the StopWordDictionary.
Iterator<String>	iterator() Returns an iterator that iterates through the collection.
void	removeRange(Iterable<String> words) Removes the specified collection of words from this instance of the StopWordDictionary.
void	removeRange(String[] words) Removes the specified collection of words from this instance of the StopWordDictionary.

Methods inherited from interface com.groupdocs.search.dictionaries.DictionaryBase

exportDictionary, getDictionaryType, importDictionary

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addRange

void addRange(Iterable<String> words)

Adds the specified collection of words to this instance of the StopWordDictionary.

Parameters:

words - The collection of words to add to the dictionary.

addRange

void addRange(String[] words)

Adds the specified collection of words to this instance of the StopWordDictionary.

Parameters:

words - The collection of words to add to the dictionary.

clear

void clear()

Removes all words from a StopWordDictionary object.

Specified by:

clear in interface DictionaryBase

contains

boolean contains(String word)

Determines whether a StopWordDictionary object contains the specified word.

Parameters:

word - The word to locate in the StopWordDictionary object.

Returns:

true if the StopWordDictionary object contains the specified word; otherwise, false.

getCount

int getCount()

Gets the number of stop words contained in the StopWordDictionary.

Returns:

The number of stop words in the dictionary.

iterator

Iterator<String> iterator()

Returns an iterator that iterates through the collection.

Specified by:

iterator in interface Iterable<String>

Returns:

An iterator that can be used to iterate through the collection.

removeRange

void removeRange(Iterable<String> words)

Removes the specified collection of words from this instance of the StopWordDictionary.

Parameters:

words - The collection of words to remove.

removeRange

void removeRange(String[] words)

Removes the specified collection of words from this instance of the StopWordDictionary.

Parameters:

words - The collection of words to remove.