com.groupdocs.search.dictionaries

Interface PasswordDictionary

All Superinterfaces:

DictionaryBase, Iterable<String>

public interface PasswordDictionary
extends DictionaryBase, Iterable<String>

Defines interface of a dictionary of document passwords.

Learn more

• Indexing password protected documents
• Managing document passwords

Method Summary

Modifier and Type	Method and Description
void	add(String filePath, String password) Adds a password for a document to the dictionary.
void	clear() Removes all passwords from this PasswordDictionary object.
boolean	contains(String filePath) Determines whether the dictionary contains a password for the specified document.
int	getCount() Gets the number of elements contained in the dictionary.
String	getPassword(String filePath) Gets the password for the file.
Iterator<String>	iterator() Returns an iterator that iterates through the collection.
boolean	remove(String filePath) Removes a password of the specified document from the dictionary.

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 filePath,
         String password)

Adds a password for a document to the dictionary.

Parameters:

filePath - The document file path.

password - The document password.

clear

void clear()

Removes all passwords from this PasswordDictionary object.

Specified by:

clear in interface DictionaryBase

contains

boolean contains(String filePath)

Determines whether the dictionary contains a password for the specified document.

Parameters:

filePath - The document file path.

Returns:

true if the dictionary contains a password for the document; otherwise, false.

getCount

int getCount()

Gets the number of elements contained in the dictionary.

Returns:

The number of elements contained in the dictionary.

getPassword

String getPassword(String filePath)

Gets the password for the file.

Parameters:

filePath - The file path.

Returns:

The password for the file.

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 filePath)

Removes a password of the specified document from the dictionary.

Parameters:

filePath - The document file path.

Returns:

true if the password was successfully removed; otherwise, false. This method also returns false if filePath was not found in the dictionary.