com.snowtide

Enum PDF.Feature

java.lang.Object

java.lang.Enum<PDF.Feature>

com.snowtide.PDF.Feature

All Implemented Interfaces:

java.lang.Comparable<PDF.Feature>

Enclosing class:

PDF

public static enum PDF.Feature
extends java.lang.Enum<PDF.Feature>

An enumeration of the discrete features available within PDFxStream. Use PDF.hasFeature(com.snowtide.PDF.Feature) to determine at runtime whether the loaded license file includes a given Feature. If an API call requires a feature that isn't enabled by the loaded license file, the call will throw an InsufficientLicenseException.

Version:

©2004-2024 Snowtide

Enum Constant Summary

Enum Constants

Enum Constant and Description
Base Corresponds to the PDFxStream Base featureset.
Forms Corresponds to the PDFFormStream featureset.
Images Corresponds to the PDFImageStream featureset.
Text Corresponds to the PDFTextStream featureset.

Method Summary

Modifier and Type	Method and Description
static PDF.Feature	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PDF.Feature[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Enum Constant Detail

Base

public static final PDF.Feature Base

Corresponds to the PDFxStream Base featureset. All PDFxStream licenses enable it, as it provides all of the foundational capabilities for reading and decoding PDF data. Additionally, it includes a number of basic PDF content extraction capabilities, including:

• decryption of encrypted PDF documents
• Extraction of PDF annotations
• Extraction of embedded files and attachments
• Extraction of bookmarks
• Extraction of document metadata, as either key/value pairs or XML
• Extraction of "raw" character data
• Extraction of image metadata, including image dimensions, locations, and types
• PDF file merging

Text

public static final PDF.Feature Text

Corresponds to the PDFTextStream featureset. When enabled, it provides a variety of capabilities related to PDF text extraction, including:

• Automated layout processing, providing a traversable PDF document model
• Serialization of the document model to text via Page.pipe(com.snowtide.pdf.OutputHandler), extensible via the OutputHandler interface
• Various OutputHandler implementations, covering most common text extraction use cases:
  • OutputTarget
  • VisualOutputTarget
  • RegionOutputTarget
  • SelectionOutputTarget
  • GoogleHTMLOutputHandler
  • XMLOutputTarget
• Basic detection and inference of tables, with related utilities

Images

public static final PDF.Feature Images

Corresponds to the PDFImageStream featureset. When enabled, it provides a variety of capabilities related to PDF image extraction, including:

• Support for decompressing and decoding dozens of different PDF image types
• Support for rendering to on-screen graphics contexts or saving to disk in familiar formats
• Automatic composition of images encoded in PDF documents as tiles or strips

Forms

public static final PDF.Feature Forms

Corresponds to the PDFFormStream featureset. When enabled, it provides a variety of capabilities related to PDF form extraction, including:

• Easy and simple APIs for extracting and filling interactive and XFA forms
• Comprehensive form field support, including text, checkboxes, buttons, radio buttons, signature, and select fields.

Method Detail

values

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

Returns:

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

valueOf

public static PDF.Feature valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null