PasswordSaveOption
Contents
[
Hide
]
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);
}
Fields
| 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. |
Methods
| Method | Description |
|---|---|
| values() | |
| valueOf(String name) | |
| fromString(String toStringValue) | Parses string representation of PasswordSaveOption to get the enum constant. |
| toString() | String representation of PasswordSaveOption. |
NONE
public static final PasswordSaveOption NONE
Do not save the password.
SOURCE
public static final PasswordSaveOption SOURCE
Use password from source document.
TARGET
public static final PasswordSaveOption TARGET
Use password from target document.
USER
public static final PasswordSaveOption USER
* Use password provided by user.
values()
public static PasswordSaveOption[] values()
Returns: com.groupdocs.comparison.options.enums.PasswordSaveOption[]
valueOf(String name)
public static PasswordSaveOption valueOf(String name)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String |
Returns: PasswordSaveOption
fromString(String toStringValue)
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
toString()
public String toString()
String representation of PasswordSaveOption.
Returns: java.lang.String - string value of enum constant