StopWordDictionary
All Implemented Interfaces: com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
public interface StopWordDictionary extends DictionaryBase, Iterable<String>
Defines interface of a dictionary of stop words.
Learn more
Methods
| Method | Description |
|---|---|
| getCount() | Gets the number of stop words contained in the StopWordDictionary . |
| addRange(Iterable |
Adds the specified collection of words to this instance of the StopWordDictionary . |
| addRange(String[] words) | Adds the specified collection of words to this instance of the StopWordDictionary . |
| removeRange(Iterable |
Removes the specified collection of words from this instance of the StopWordDictionary . |
| removeRange(String[] words) | Removes the specified collection of words from this instance of the StopWordDictionary . |
| contains(String word) | Determines whether a StopWordDictionary object contains the specified word. |
| clear() | Removes all words from a StopWordDictionary object. |
| iterator() | Returns an iterator that iterates through the collection. |
getCount()
public abstract int getCount()
Gets the number of stop words contained in the StopWordDictionary .
Returns: int - The number of stop words in the dictionary.
addRange(Iterable words)
public abstract void addRange(Iterable<String> words)
Adds the specified collection of words to this instance of the StopWordDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| words | java.lang.Iterable<java.lang.String> | The collection of words to add to the dictionary. |
addRange(String[] words)
public abstract void addRange(String[] words)
Adds the specified collection of words to this instance of the StopWordDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| words | java.lang.String[] | The collection of words to add to the dictionary. |
removeRange(Iterable words)
public abstract void removeRange(Iterable<String> words)
Removes the specified collection of words from this instance of the StopWordDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| words | java.lang.Iterable<java.lang.String> | The collection of words to remove. |
removeRange(String[] words)
public abstract void removeRange(String[] words)
Removes the specified collection of words from this instance of the StopWordDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| words | java.lang.String[] | The collection of words to remove. |
contains(String word)
public abstract boolean contains(String word)
Determines whether a StopWordDictionary object contains the specified word.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| word | java.lang.String | The word to locate in the StopWordDictionary object. |
Returns: boolean - true if the StopWordDictionary object contains the specified word; otherwise, false .
clear()
public abstract void clear()
Removes all words from a StopWordDictionary object.
iterator()
public abstract Iterator<String> iterator()
Returns an iterator that iterates through the collection.
Returns: java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.