OptSettings (Qoppa jPDFOptimizer API)

java.lang.Object
- com.qoppa.pdfOptimizer.OptSettings

```
public class OptSettings
extends Object
```
This object holds the settings to be applied by PDFOptimizer during optimization. By default, duplicate images will be merged, duplicate fonts will be merged, uncompressed streams will be compressed, and unused resources will be discarded.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`JPEG_RECOMPRESS_ALWAYS` Always recompress JPEG images.
`static int`	`JPEG_RECOMPRESS_NEVER` Never recompress JPEG images.
`static int`	`JPEG_RECOMPRESS_SMALLER` Recompress JPEG images if the resulting image will be smaller.

Constructor Summary

Constructors
Constructor and Description

OptSettings()

Constructors
Constructor and Description
`OptSettings()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ImageHandler`	`getImageHandler()` Returns the image handler currently registered with these settings.
`int`	`getJPEGRecompressLogic()` Deprecated. This setting will no longer be applied. Instead use `ImageOutput.getOnlyChangeIfSmaller`.
`boolean`	`isClearSignatures()` Returns true if signatures should be cleared.
`boolean`	`isClearUsageRights()` Returns true if usage rights should be cleared.
`boolean`	`isCompressObjectsIntoStreams()` Returns true if objects will be compressed into object streams during optimization.
`boolean`	`isDiscardAltImages()` Returns true if alternate images will be discarded during optimization.
`boolean`	`isDiscardAnnotations()` Returns true if annotations will be discarded during optimization.
`boolean`	`isDiscardBookmarks()` Returns true if bookmarks will be discarded during optimization.
`boolean`	`isDiscardDocumentInfo()` Returns true if document info will be discarded during optimization.
`boolean`	`isDiscardFileAttachments()` Returns true if file attachments will be discarded during optimization.
`boolean`	`isDiscardFormFields()` Returns true if form fields will be discarded during optimization.
`boolean`	`isDiscardJSActions()` Returns true if JavaScript actions will be discarded during optimization.
`boolean`	`isDiscardLinks()` Returns true if links will be discarded during optimization.
`boolean`	`isDiscardPageThumbnails()` Returns true if page thumbnails will be discarded during optimization.
`boolean`	`isDiscardUnusedBookmarks()` Returns true if unused bookmarks will be discarded during optimization.
`boolean`	`isDiscardUnusedLinks()` Returns true if unused links will be discarded during optimization.
`boolean`	`isDiscardUnusedResources()` Returns true if unused resources will be discarded during optimization.
`boolean`	`isDiscardXMPData()` Returns true if XMP metadata will be discarded during optimization.
`boolean`	`isFlateUncompressedStreams()` Returns true if uncompressed streams will be compressed during optimization.
`boolean`	`isFlattenAnnotations()` Returns true if annotations will be flattened during optimization.
`boolean`	`isFlattenFormFields()` Returns true if form fields will be flattened during optimization.
`boolean`	`isFlattenLayers()` Returns true if layers will be flattened during optimization.
`boolean`	`isJPEGConvertCMYKToRGBOn17()` Returns the value of the "convert CMYK to RGB when compressing to JPEG and running in Java 7 or higher".
`boolean`	`isLinearize()` Returns true if the document will be linearized during optimization.
`boolean`	`isMergeDuplicateFonts()` Returns true if duplicate fonts will be merged during optimization.
`boolean`	`isMergeDuplicateImages()` Returns true if duplicate images will be merged during optimization.
`void`	`setClearSignatures(boolean clearSignatures)` Sets the flag to clear signatures during optimization.
`void`	`setClearUsageRights(boolean clearUsageRights)` Sets the flag to clear usage rights during optimization.
`void`	`setCompressObjectsIntoStreams(boolean compressObjectsIntoStreams)` Sets the flag to compress objects into object streams during optimization.
`void`	`setDiscardAltImages(boolean discardAltImages)` Sets the flag to discard alternate images during optimization.
`void`	`setDiscardAnnotations(boolean discardAnnotations)` Sets the flag to discard annotations during optimization.
`void`	`setDiscardBookmarks(boolean discardBookmarks)` Set to true to discard bookmarks during optimization.
`void`	`setDiscardDocumentInfo(boolean discardDocumentInfo)` Sets the flag to discard document info during optimization.
`void`	`setDiscardFileAttachments(boolean discardFileAttachments)` Sets the flag to discard file attachments during optimization.
`void`	`setDiscardFormFields(boolean discardFormFields)` Sets the flag to discard form fields during optimization.
`void`	`setDiscardJSActions(boolean discardJSActions)` Sets the flag to discard JavaScript actions during optimization.
`void`	`setDiscardLinks(boolean discardLinks)` Set the flag to discard links during optimization.
`void`	`setDiscardPageThumbnails(boolean discardPageThumbnails)` Sets the flag to discard page thumbnails during optimization.
`void`	`setDiscardUnusedBookmarks(boolean b)` Set to true to discard unused bookmarks during optimization.
`void`	`setDiscardUnusedLinks(boolean b)` Set to true to discard unused links during optimization.
`void`	`setDiscardUnusedResources(boolean discardUnusedResources)` Sets the flag to discard unused resources during optimization.
`void`	`setDiscardXMPData(boolean discardXMPData)` Sets the flag to discard XMP metadata during optimization.
`void`	`setFlateUncompressedStreams(boolean flateUncompressedStreams)` Sets the flag to compress uncompressed streams during optimization.
`void`	`setFlattenAnnotations(boolean flattenAnnotations)` Sets the flag to flatten annotations during optimization.
`void`	`setFlattenFormFields(boolean flattenFormFields)` Sets the flag to flatten form fields during optimization.
`void`	`setFlattenLayers(boolean flattenLayers)` Sets the flag to flatten layers during optimization.
`void`	`setImageHandler(ImageHandler ih)` Sets the image handler for these optimization settings.
`void`	`setJPEGConvertCMYKToRGBOn17(boolean convert)` Sets the flag to convert CMYK images to RGB when compressing to JPEG, when running in Java 7 or higher.
`void`	`setJPEGRecompressLogic(int recompress)` Deprecated. This setting will no longer be applied. Instead use `ImageOutput.setOnlyChangeIfSmaller`.
`void`	`setLinearize(boolean linearize)` Sets the flag to linearize the document during optimization.
`void`	`setMergeDuplicateFonts(boolean mergeDuplicateFonts)` Sets the flag to merge duplicate fonts during optimization.
`void`	`setMergeDuplicateImages(boolean mergeDuplicateImages)` Sets the flag to merge duplicate images during optimization.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JPEG_RECOMPRESS_NEVER
```
public static final int JPEG_RECOMPRESS_NEVER
```
    Never recompress JPEG images. Note that images will still be recompressed if there are other changes applied to the image (i.e. color space). This is the default value.
    
    See Also:
    
    Constant Field Values
  - JPEG_RECOMPRESS_ALWAYS
```
public static final int JPEG_RECOMPRESS_ALWAYS
```
    Always recompress JPEG images.
    
    See Also:
    
    Constant Field Values
  - JPEG_RECOMPRESS_SMALLER
```
public static final int JPEG_RECOMPRESS_SMALLER
```
    Recompress JPEG images if the resulting image will be smaller.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OptSettings
```
public OptSettings()
```
- Method Detail
  - isMergeDuplicateImages
```
public boolean isMergeDuplicateImages()
```
    Returns true if duplicate images will be merged during optimization.
    
    Returns:
    
    true if duplicate images will be merged during optimization.
  - setMergeDuplicateImages
```
public void setMergeDuplicateImages(boolean mergeDuplicateImages)
```
    Sets the flag to merge duplicate images during optimization. The default value is true.
    
    Parameters:
    
    mergeDuplicateImages - The new value of the merge duplicate images flag.
  - isMergeDuplicateFonts
```
public boolean isMergeDuplicateFonts()
```
    Returns true if duplicate fonts will be merged during optimization.
    
    Returns:
    
    true if duplicate fonts will be merged during optimization.
  - setMergeDuplicateFonts
```
public void setMergeDuplicateFonts(boolean mergeDuplicateFonts)
```
    Sets the flag to merge duplicate fonts during optimization. The default value is true.
    
    Parameters:
    
    mergeDuplicateFonts - The new value of the merge duplicate fonts flag.
  - isClearSignatures
```
public boolean isClearSignatures()
```
    Returns true if signatures should be cleared.
    
    Returns:
    
    true if signatures should be cleared.
  - setClearSignatures
```
public void setClearSignatures(boolean clearSignatures)
```
    Sets the flag to clear signatures during optimization. The default value is false.
    
    Parameters:
    
    clearSignatures - The new value of the clear signatures flag.
  - isClearUsageRights
```
public boolean isClearUsageRights()
```
    Returns true if usage rights should be cleared.
    
    Returns:
    
    true if usage rights should be cleared.
  - setClearUsageRights
```
public void setClearUsageRights(boolean clearUsageRights)
```
    Sets the flag to clear usage rights during optimization. The default value is true.
    
    Parameters:
    
    clearUsageRights - The new value of the clear usage rights flag.
  - isDiscardAltImages
```
public boolean isDiscardAltImages()
```
    Returns true if alternate images will be discarded during optimization.
    
    Returns:
    
    true if alternate images will be discarded during optimization.
  - setDiscardAltImages
```
public void setDiscardAltImages(boolean discardAltImages)
```
    Sets the flag to discard alternate images during optimization. The default value is false.
    
    Parameters:
    
    discardAltImages - The new value of the discard alternate images flag.
  - isDiscardPageThumbnails
```
public boolean isDiscardPageThumbnails()
```
    Returns true if page thumbnails will be discarded during optimization.
    
    Returns:
    
    true if page thumbnails will be discarded during optimization.
  - setDiscardPageThumbnails
```
public void setDiscardPageThumbnails(boolean discardPageThumbnails)
```
    Sets the flag to discard page thumbnails during optimization. The default value is false.
    
    Parameters:
    
    discardPageThumbnails - The new value of the discard page thumbnails flag.
  - isDiscardJSActions
```
public boolean isDiscardJSActions()
```
    Returns true if JavaScript actions will be discarded during optimization.
    
    Returns:
    
    true if JavaScript actions will be discarded during optimization.
  - setDiscardJSActions
```
public void setDiscardJSActions(boolean discardJSActions)
```
    Sets the flag to discard JavaScript actions during optimization. The default value is false.
    
    Parameters:
    
    discardJSActions - The new value of the discard JavaScript actions flag.
  - isDiscardXMPData
```
public boolean isDiscardXMPData()
```
    Returns true if XMP metadata will be discarded during optimization. This will remove the metatdata entry from the root catalog.
    
    Returns:
    
    true if XMP metadata will be discarded during optimization.
  - setDiscardXMPData
```
public void setDiscardXMPData(boolean discardXMPData)
```
    Sets the flag to discard XMP metadata during optimization. The default value is false.
    
    Parameters:
    
    discardXMPData - The new value of the discard XMP metadata flag.
  - isDiscardDocumentInfo
```
public boolean isDiscardDocumentInfo()
```
    Returns true if document info will be discarded during optimization.
    
    Returns:
    
    true if document info will be discarded during optimization.
  - setDiscardDocumentInfo
```
public void setDiscardDocumentInfo(boolean discardDocumentInfo)
```
    Sets the flag to discard document info during optimization. The default value is false.
    
    Parameters:
    
    discardDocumentInfo - The new value of the discard document info flag.
  - isDiscardBookmarks
```
public boolean isDiscardBookmarks()
```
    Returns true if bookmarks will be discarded during optimization.
    
    Returns:
    
    true if bookmarks will be discarded during optimization.
  - setDiscardBookmarks
```
public void setDiscardBookmarks(boolean discardBookmarks)
```
    Set to true to discard bookmarks during optimization. The default value is false.
    
    Parameters:
    
    discardBookmarks - The new value of the discard bookmarks flag.
  - isDiscardLinks
```
public boolean isDiscardLinks()
```
    Returns true if links will be discarded during optimization.
    
    Returns:
    
    true if links will be discarded during optimization.
  - setDiscardLinks
```
public void setDiscardLinks(boolean discardLinks)
```
    Set the flag to discard links during optimization. The default value is false.
    
    Parameters:
    
    discardLinks - The new value of the discard links flag.
  - isDiscardAnnotations
```
public boolean isDiscardAnnotations()
```
    Returns true if annotations will be discarded during optimization.
    
    Returns:
    
    true if annotations will be discarded during optimization.
  - setDiscardAnnotations
```
public void setDiscardAnnotations(boolean discardAnnotations)
```
    Sets the flag to discard annotations during optimization. The default value is false.
    
    Parameters:
    
    discardAnnotations - The new value of the discard annotations flag.
  - isDiscardFormFields
```
public boolean isDiscardFormFields()
```
    Returns true if form fields will be discarded during optimization.
    
    Returns:
    
    true if form fields will be discarded during optimization.
  - setDiscardFormFields
```
public void setDiscardFormFields(boolean discardFormFields)
```
    Sets the flag to discard form fields during optimization. The default value is false.
    
    Parameters:
    
    discardFormFields - The new value of the discard form fields flag.
  - isDiscardUnusedResources
```
public boolean isDiscardUnusedResources()
```
    Returns true if unused resources will be discarded during optimization.
    
    Returns:
    
    true if unused resources will be discarded during optimization.
  - setDiscardUnusedResources
```
public void setDiscardUnusedResources(boolean discardUnusedResources)
```
    Sets the flag to discard unused resources during optimization. The default value is true.
    
    Parameters:
    
    discardUnusedResources - The new value of the discard unused resources flag.
  - isDiscardFileAttachments
```
public boolean isDiscardFileAttachments()
```
    Returns true if file attachments will be discarded during optimization.
    
    Returns:
    
    true if file attachments will be discarded during optimization.
  - setDiscardFileAttachments
```
public void setDiscardFileAttachments(boolean discardFileAttachments)
```
    Sets the flag to discard file attachments during optimization. The default value is false.
    
    Parameters:
    
    discardFileAttachments - The new value of the discard file attachments flag.
  - isFlattenAnnotations
```
public boolean isFlattenAnnotations()
```
    Returns true if annotations will be flattened during optimization.
    
    Returns:
    
    true if annotations will be flattened during optimization.
  - setFlattenAnnotations
```
public void setFlattenAnnotations(boolean flattenAnnotations)
```
    Sets the flag to flatten annotations during optimization. The default value is false.
    
    Parameters:
    
    flattenAnnotations - The new value of the flatten annotations flag.
  - isFlattenFormFields
```
public boolean isFlattenFormFields()
```
    Returns true if form fields will be flattened during optimization.
    
    Returns:
    
    true if form fields will be flattened during optimization.
  - setFlattenFormFields
```
public void setFlattenFormFields(boolean flattenFormFields)
```
    Sets the flag to flatten form fields during optimization. The default value is false.
    
    Parameters:
    
    flattenFormFields - The new value of the flatten form fields flag.
  - isFlattenLayers
```
public boolean isFlattenLayers()
```
    Returns true if layers will be flattened during optimization.
    
    Returns:
    
    true if layers will be flattened during optimization.
  - setFlattenLayers
```
public void setFlattenLayers(boolean flattenLayers)
```
    Sets the flag to flatten layers during optimization. The default value is false.
    
    Parameters:
    
    flattenLayers - The new value of the flatten layers flag.
  - isFlateUncompressedStreams
```
public boolean isFlateUncompressedStreams()
```
    Returns true if uncompressed streams will be compressed during optimization.
    
    Returns:
    
    true if uncompressed streams will be compressed during optimization.
  - setFlateUncompressedStreams
```
public void setFlateUncompressedStreams(boolean flateUncompressedStreams)
```
    Sets the flag to compress uncompressed streams during optimization. The default value is true.
    
    Parameters:
    
    flateUncompressedStreams - The new value of the flate uncompressed streams flag.
  - isCompressObjectsIntoStreams
```
public boolean isCompressObjectsIntoStreams()
```
    Returns true if objects will be compressed into object streams during optimization. The default value is true.
    
    Returns:
    
    true if objects will be compressed into object streams during optimization.
  - setCompressObjectsIntoStreams
```
public void setCompressObjectsIntoStreams(boolean compressObjectsIntoStreams)
```
    Sets the flag to compress objects into object streams during optimization. The default value is true.
    
    Parameters:
    
    compressObjectsIntoStreams - The new value of the compress objects into streams flag.
  - setLinearize
```
public void setLinearize(boolean linearize)
```
    Sets the flag to linearize the document during optimization. The default value is false.
    
    Parameters:
    
    linearize - The new value of the linearize flag.
  - isLinearize
```
public boolean isLinearize()
```
    Returns true if the document will be linearized during optimization.
    
    Returns:
    
    true if the document will be linearized during optimization.
  - getImageHandler
```
public ImageHandler getImageHandler()
```
    Returns the image handler currently registered with these settings.
    
    Returns:
    
    The image handler.
  - setImageHandler
```
public void setImageHandler(ImageHandler ih)
```
    Sets the image handler for these optimization settings.
    
    Parameters:
    
    ih - The new image handler implementation.
  - setJPEGConvertCMYKToRGBOn17
```
public void setJPEGConvertCMYKToRGBOn17(boolean convert)
```
    Sets the flag to convert CMYK images to RGB when compressing to JPEG, when running in Java 7 or higher. This flag is needed because there is a regression bug in Java 7 that broke JPEG compression of CMYK images. In Java 6, ImageIO is able to compress CMYK images to JPEG, but Java 7 and Java 8 throw an exception. When this flag is set to true, and jPDFOptimizer is running in Java 7 or higher, it will convert CMYK images to RGB before compressing to JPEG. If the flag is false, jPDFOptimizer will make the calls to ImageIO without converting, and will let the exception from ImageIO go through. By default, this flag is set to true.
    
    Parameters:
    
    convert - The new value of the flag.
  - isJPEGConvertCMYKToRGBOn17
```
public boolean isJPEGConvertCMYKToRGBOn17()
```
    Returns the value of the "convert CMYK to RGB when compressing to JPEG and running in Java 7 or higher". See documentation for setJPEGConvertCMYKToRGBOn17(boolean) method for more details.
    
    Returns:
    
    The current value of the flag.
  - setJPEGRecompressLogic
```
public void setJPEGRecompressLogic(int recompress)
```
    Deprecated. This setting will no longer be applied. Instead use ImageOutput.setOnlyChangeIfSmaller.
    
    Set the JPEG recompression logic. The value should be one of the following: OptSettings.JPEG_RECOMPRESS_NEVER, OptSettings.JPEG_RECOMPRESS_ALWAYS, OptSettings.JPEG_RECOMPRESS_SMALLER. The default value is OptSettings.JPEG_RECOMPRESS_NEVER.
    
    Parameters:
    
    recompress - The JPEG recompression logic. One of OptSettings.JPEG_RECOMPRESS_NEVER, OptSettings.JPEG_RECOMPRESS_ALWAYS, OptSettings.JPEG_RECOMPRESS_SMALLER.
  - getJPEGRecompressLogic
```
public int getJPEGRecompressLogic()
```
    Deprecated. This setting will no longer be applied. Instead use ImageOutput.getOnlyChangeIfSmaller.
    
    Set the JPEG recompression logic. The value will be one of the following: OptSettings.JPEG_RECOMPRESS_NEVER, OptSettings.JPEG_RECOMPRESS_ALWAYS, OptSettings.JPEG_RECOMPRESS_SMALLER.
    
    Returns:
    
    The JPEG recompression logic.
  - isDiscardUnusedLinks
```
public boolean isDiscardUnusedLinks()
```
    Returns true if unused links will be discarded during optimization.
    
    Returns:
    
    true if unused links will be discarded during optimization.
  - setDiscardUnusedLinks
```
public void setDiscardUnusedLinks(boolean b)
```
    Set to true to discard unused links during optimization. The default value is false.
    
    Parameters:
    
    b - The new value of the flag.
  - isDiscardUnusedBookmarks
```
public boolean isDiscardUnusedBookmarks()
```
    Returns true if unused bookmarks will be discarded during optimization.
    
    Returns:
    
    true if unused bookmarks will be discarded during optimization.
  - setDiscardUnusedBookmarks
```
public void setDiscardUnusedBookmarks(boolean b)
```
    Set to true to discard unused bookmarks during optimization. The default value is false.
    
    Parameters:
    
    b - The new value of the flag.

Class OptSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JPEG_RECOMPRESS_NEVER

JPEG_RECOMPRESS_ALWAYS

JPEG_RECOMPRESS_SMALLER

Constructor Detail

OptSettings

Method Detail

isMergeDuplicateImages

setMergeDuplicateImages

isMergeDuplicateFonts

setMergeDuplicateFonts

isClearSignatures

setClearSignatures

isClearUsageRights

setClearUsageRights

isDiscardAltImages

setDiscardAltImages

isDiscardPageThumbnails

setDiscardPageThumbnails

isDiscardJSActions

setDiscardJSActions

isDiscardXMPData

setDiscardXMPData

isDiscardDocumentInfo

setDiscardDocumentInfo

isDiscardBookmarks

setDiscardBookmarks

isDiscardLinks

setDiscardLinks

isDiscardAnnotations

setDiscardAnnotations

isDiscardFormFields

setDiscardFormFields

isDiscardUnusedResources

setDiscardUnusedResources

isDiscardFileAttachments

setDiscardFileAttachments

isFlattenAnnotations

setFlattenAnnotations

isFlattenFormFields

setFlattenFormFields

isFlattenLayers

setFlattenLayers

isFlateUncompressedStreams

setFlateUncompressedStreams

isCompressObjectsIntoStreams

setCompressObjectsIntoStreams

setLinearize

isLinearize

getImageHandler

setImageHandler

setJPEGConvertCMYKToRGBOn17

isJPEGConvertCMYKToRGBOn17

setJPEGRecompressLogic

getJPEGRecompressLogic

isDiscardUnusedLinks

setDiscardUnusedLinks

isDiscardUnusedBookmarks

setDiscardUnusedBookmarks