com.groupdocs.search.dictionaries

Interface AliasDictionary

All Superinterfaces:

DictionaryBase, Iterable<String>

public interface AliasDictionary
extends DictionaryBase, Iterable<String>

Defines interface of a dictionary of aliases.

Learn more

• Using aliases
• Managing alias dictionary

Method Summary

Modifier and Type	Method and Description
void	add(String alias, String text) Adds the specified pair of alias and associated text to this instance of the AliasDictionary.
void	addRange(AliasReplacementPair[] pairs) Adds the specified collection of alias/replacement pairs to this instance of the AliasDictionary.
void	addRange(Iterable<AliasReplacementPair> pairs) Adds the specified collection of alias/replacement pairs to this instance of the AliasDictionary.
void	clear() Removes all aliases from a AliasDictionary object.
boolean	contains(String alias) Determines whether an AliasDictionary object contains the specified alias.
int	getCount() Gets the number of aliases contained in the AliasDictionary.
String	getText(String alias) Gets a text that is associated with the specified alias.
Iterator<String>	iterator() Returns an iterator that iterates through the collection.
boolean	remove(String alias) Removes the specified alias from an AliasDictionary object.

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

exportDictionary, getDictionaryType, importDictionary

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

void add(String alias,
         String text)

Adds the specified pair of alias and associated text to this instance of the AliasDictionary.

Parameters:

alias - The alias to add to the dictionary.

text - The text to be associated with the alias.

addRange

void addRange(AliasReplacementPair[] pairs)

Adds the specified collection of alias/replacement pairs to this instance of the AliasDictionary.

Parameters:

pairs - The collection of alias/replacement pairs to add to the dictionary.

addRange

void addRange(Iterable<AliasReplacementPair> pairs)

Adds the specified collection of alias/replacement pairs to this instance of the AliasDictionary.

Parameters:

pairs - The collection of alias/replacement pairs to add to the dictionary.

clear

void clear()

Removes all aliases from a AliasDictionary object.

Specified by:

clear in interface DictionaryBase

contains

boolean contains(String alias)

Determines whether an AliasDictionary object contains the specified alias.

Parameters:

alias - The alias to locate in the AliasDictionary object.

Returns:

true if the AliasDictionary object contains the specified alias; otherwise, false.

getCount

int getCount()

Gets the number of aliases contained in the AliasDictionary.

Returns:

The number of aliases contained in the AliasDictionary.

getText

String getText(String alias)

Gets a text that is associated with the specified alias.

Parameters:

alias - The alias to locate in the AliasDictionary object.

Returns:

A text associated with the specified alias or null.

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.

remove

boolean remove(String alias)

Removes the specified alias from an AliasDictionary object.

Parameters:

alias - The alias to remove.

Returns:

This method returns true if the alias is successfully found and removed. This method returns false if the alias is not found in the AliasDictionary object.