com.groupdocs.comparison.options.enums

Enum PasswordSaveOption

java.lang.Object

java.lang.Enum<PasswordSaveOption>

com.groupdocs.comparison.options.enums.PasswordSaveOption

All Implemented Interfaces:

Serializable, Comparable<PasswordSaveOption>

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);
 }
 

See Also:

Comparer, CompareOptions

Enum Constant Summary

Enum Constants

Enum Constant and 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 Summary

Modifier and Type	Method and Description
static PasswordSaveOption	fromString(String toStringValue) Parses string representation of PasswordSaveOption to get the enum constant.
String	toString() String representation of PasswordSaveOption.
static PasswordSaveOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static PasswordSaveOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

Method Detail

fromString

public static PasswordSaveOption fromString(String toStringValue)

Parses string representation of PasswordSaveOption to get the enum constant.

Parameters:

toStringValue - The string representation of PasswordSaveOption

Returns:

PasswordSaveOption enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of PasswordSaveOption values

toString

public String toString()

String representation of PasswordSaveOption.

Overrides:

toString in class Enum<PasswordSaveOption>

Returns:

string value of enum constant

valueOf

public static PasswordSaveOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static PasswordSaveOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PasswordSaveOption c : PasswordSaveOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared