PasswordSaveOption
Leave feedback
On this page
Inheritance: java.lang.Object, java.lang.Enum
public enum PasswordSaveOption extends Enum<PasswordSaveOption>
Enumerates the options for saving password information in a document during the comparison process.
Example usage:
try (Comparer comparer = new Comparer(sourceFile)) {
comparer.add(targetFile);
CompareOptions compareOptions = new CompareOptions();
compareOptions.setPasswordSaveOption(PasswordSaveOption.SOURCE);
comparer.compare(resultFile, compareOptions);
}
| Field | Description |
|---|---|
| NONE | Do not save the password. |
| SOURCE | Use password from source document. |
| TARGET | Use password from target document. |
| USER | * Use password provided by user. |
| Method | Description |
|---|---|
| values() | |
| valueOf(String name) | |
| fromString(String toStringValue) | Parses string representation of PasswordSaveOption to get the enum constant. |
| toString() | String representation of PasswordSaveOption. |
public static final PasswordSaveOption NONE
Do not save the password.
public static final PasswordSaveOption SOURCE
Use password from source document.
public static final PasswordSaveOption TARGET
Use password from target document.
public static final PasswordSaveOption USER
* Use password provided by user.
public static PasswordSaveOption[] values()
Returns: com.groupdocs.comparison.options.enums.PasswordSaveOption[]
public static PasswordSaveOption valueOf(String name)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String |
Returns: PasswordSaveOption
public static PasswordSaveOption fromString(String toStringValue)
Parses string representation of PasswordSaveOption to get the enum constant.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| toStringValue | java.lang.String | The string representation of PasswordSaveOption |
Returns: PasswordSaveOption - PasswordSaveOption enum constant associated with input string
public String toString()
String representation of PasswordSaveOption.
Returns: java.lang.String - string value of enum constant
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.