com.groupdocs.comparison.options.enums

Enum MetadataType

java.lang.Object

java.lang.Enum<MetadataType>

com.groupdocs.comparison.options.enums.MetadataType

All Implemented Interfaces:

Serializable, Comparable<MetadataType>

public enum MetadataType
extends Enum<MetadataType>

Determines from where the result document will take metadata information.

Example usage:

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    SaveOptions saveOptions = new SaveOptions();
    saveOptions.setCloneMetadataType(MetadataType.FILE_AUTHOR);

    comparer.compare(resultFile, saveOptions);
 }
 

See Also:

Comparer, SaveOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Metadata will be left as is.
FILE_AUTHOR Metedata will be set by user.
SOURCE Metedata will be taken from source document.
TARGET Metedata will be taken from target document.

Method Summary

Modifier and Type	Method and Description
static MetadataType	fromString(String toStringValue) Parses string representation of MetadataType to get the enum constant.
String	toString() String representation of MetadataType.
static MetadataType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetadataType[]	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

DEFAULT

public static final MetadataType DEFAULT

Metadata will be left as is.

FILE_AUTHOR

public static final MetadataType FILE_AUTHOR

Metedata will be set by user.

SOURCE

public static final MetadataType SOURCE

Metedata will be taken from source document.

TARGET

public static final MetadataType TARGET

Metedata will be taken from target document.

Method Detail

fromString

public static MetadataType fromString(String toStringValue)

Parses string representation of MetadataType to get the enum constant.

Parameters:

toStringValue - The string representation of MetadataType

Returns:

MetadataType enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of MetadataType values

toString

public String toString()

String representation of MetadataType.

Overrides:

toString in class Enum<MetadataType>

Returns:

string value of enum constant

valueOf

public static MetadataType 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 MetadataType[] 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 (MetadataType c : MetadataType.values())
    System.out.println(c);

Returns:

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