com.groupdocs.comparison.options.enums

Enum PreviewFormats

java.lang.Object

java.lang.Enum<PreviewFormats>

com.groupdocs.comparison.options.enums.PreviewFormats

All Implemented Interfaces:

Serializable, Comparable<PreviewFormats>

public enum PreviewFormats
extends Enum<PreviewFormats>

Enumerates the supported preview formats for document comparison.

The PreviewFormats enum provides a list of formats that can be used to generate previews of compared documents.

Supported formats include:

• PNG - Portable Network Graphics (.png)
• JPEG - Joint Photographic Experts Group (.jpeg)
• BMP - Bitmap Picture (.bmp)

Example usage:

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

    PreviewOptions previewOptions = new PreviewOptions(
            pageNumber -> Files.newOutputStream(Paths.get(String.format("preview-page_%d.png", pageNumber)))
    );
    previewOptions.setPreviewFormat(PreviewFormats.PNG);

    comparer.getTargets().get(0).generatePreview(previewOptions);
 }
 

See Also:

Comparer, PreviewOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
BMP BMP - offers the best image quality but requires slower processing with higher disk space usage and network traffic.
JPEG Jpeg - provides faster processing with smaller disk space usage and network traffic, but may result in lower image quality.
PNG PNG - may consume significant disk space or network traffic if the page contains numerous color graphics.

Method Summary

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

BMP

public static final PreviewFormats BMP

BMP - offers the best image quality but requires slower processing with higher disk space usage and network traffic.

JPEG

public static final PreviewFormats JPEG

Jpeg - provides faster processing with smaller disk space usage and network traffic, but may result in lower image quality.

PNG

public static final PreviewFormats PNG

PNG - may consume significant disk space or network traffic if the page contains numerous color graphics. Default preview format.

Method Detail

fromString

public static PreviewFormats fromString(String toStringValue)

Parses string representation of PreviewFormats to get the enum constant.

Parameters:

toStringValue - The string representation of PreviewFormats

Returns:

PreviewFormats enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of PreviewFormats values

toString

public String toString()

String representation of PreviewFormats.

Overrides:

toString in class Enum<PreviewFormats>

Returns:

string value of enum constant

valueOf

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

Returns:

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