Package com.snowtide
Enum PDF.Feature
- java.lang.Object
-
- java.lang.Enum<PDF.Feature>
-
- com.snowtide.PDF.Feature
-
- All Implemented Interfaces:
Serializable
,Comparable<PDF.Feature>
- Enclosing class:
public static enum PDF.Feature extends Enum<PDF.Feature>
An enumeration of the discrete features available within PDFxStream. UsePDF.hasFeature(com.snowtide.PDF.Feature)
to determine at runtime whether theloaded license file
includes a givenFeature
. If an API call requires a feature that isn't enabled by the loaded license file, the call will throw anInsufficientLicenseException
.- Version:
- ©2004-2024 Snowtide
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Base
Base
is enabled in all PDFxStream licenses, as it provides all of the foundational capabilities for reading and decoding PDF data.Forms
When enabled,Forms
provides a variety of capabilities related to PDF form extraction, including: Easy and simple APIs forextracting
andfilling
interactive andXFA
forms Comprehensive form field support, includingtext
,checkboxes
,buttons
,radio buttons
,signature
, andselect
fields.Images
When enabled,Images
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 toon-screen graphics contexts
orsaving to disk
infamiliar formats
Automatic composition of images encoded in PDF documents as tiles or stripsPerpetual
Text
When enabled,Text
provides a variety of capabilities related to PDF text extraction, including: Automated layout processing, providing a traversable PDFdocument model
Serialization of the document model to text viaOutputSource.pipe(com.snowtide.pdf.OutputHandler)
, extensible via theOutputHandler
interface VariousOutputHandler
implementations, covering most common text extraction use cases:OutputTarget
VisualOutputTarget
RegionOutputTarget
SelectionOutputTarget
GoogleHTMLOutputHandler
XMLOutputTarget
Basic detection and inference oftables
, withrelated utilities
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static PDF.Feature
valueOf(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
Base
is enabled in all PDFxStream licenses, 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
orXML
- Extraction of
"raw" character data
- Extraction of image metadata, including image
dimensions
,locations
, andtypes
PDF file merging
-
Text
public static final PDF.Feature Text
When enabled,Text
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
OutputSource.pipe(com.snowtide.pdf.OutputHandler)
, extensible via theOutputHandler
interface - Various
OutputHandler
implementations, covering most common text extraction use cases: - Basic detection and inference of
tables
, withrelated utilities
- Automated layout processing, providing a traversable PDF
-
Images
public static final PDF.Feature Images
When enabled,Images
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
orsaving to disk
infamiliar formats
- Automatic composition of images encoded in PDF documents as tiles or strips
-
Forms
public static final PDF.Feature Forms
When enabled,Forms
provides a variety of capabilities related to PDF form extraction, including:- Easy and simple APIs for
extracting
andfilling
interactive andXFA
forms - Comprehensive form field support, including
text
,checkboxes
,buttons
,radio buttons
,signature
, andselect
fields.
- Easy and simple APIs for
-
Perpetual
public static final PDF.Feature Perpetual
-
-
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(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 nameNullPointerException
- if the argument is null
-
-