SaveFlags

java.lang.Object
- java.lang.Enum<SaveFlags>
- - com.datalogics.PDFL.SaveFlags

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SaveFlags>
```
public enum SaveFlags
extends java.lang.Enum<SaveFlags>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADD_FLATE` Encode any uncompressed stream witht the Flate filter.
`AUTO_SAVE` Deprecated.
`CLOSE_AFTER_SAVE` Close document after save.
`COLLECT_GARBAGE` Collect Garbage by removing unreferenced objects.
`COMPRESS_STRUCTURE_ONLY` Use object compression only for Logical Structure items.
`COMPRESSED` Use object compression wherever possible.
`COPY` Saves a copy of the document.
`DO_NOT_CREATE_TO_UNICODE_WIDTHS` Don't create /ToUnicode and /Widths entries for Fonts to improve performance.
`ENSURE_7BIT_ASCII` Deprecated.
`FULL` Save the entire document.
`INCREMENTAL` Incremental save only write objects that have changed after the end of the document rather than disturbing unchanged items.
`KEEP_MOD_DATE` Do not update the Modification Date
`LINEARIZED` Save in a format that is suitable for remote (network) access, Linearized is sometimes referred to as Web Optimized because of its goal of minimizing the perception of poor performance due to the number of pages in a document.
`OPTIMIZE_CONTENT_STREAMS` Optimize Content Streams operators where possible.
`OPTIMIZE_FONTS` Merge Font Descriptors and encoding where possible.
`OPTIMIZE_MARKED_JBIG_2DICTIONARIES` Delete symbols specific to JBIG2 Dictionaries that couldn't be removed previously.
`OPTIMIZE_XOBJECTS` Merge identical XObjects.
`REMOVE_ASCIIFILTERS` Remove the ASCII85 filter from all streams where its in use.
`REPLACE_LZW` Replace any LZW encoded stream with Flate.
`SAVE_LINEARIZED_NO_OPTIMIZE_FONTS` Save the document as Linearized the same as Linearized but OptimizeFonts is disabled.
`SAVE_ORIGINAL_METADATA` Save original /Metadata stream of input as /Metadata stream of output document.
`UNCOMPRESSED` Do not use object stream compression.
`XMPPACKET_READ_ONLY_NO_PADDING` Save XMP data as read-only without padding

Method Summary

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

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - INCREMENTAL
```
public static final SaveFlags INCREMENTAL
```
    Incremental save only write objects that have changed after the end of the document rather than disturbing unchanged items. Use with Copy to create a new file which incorporates a copy of the input file before making changes. This flag can be useful when making changes to signed documents, as it preserves the validity of any existing signatures.
  - FULL
```
public static final SaveFlags FULL
```
    Save the entire document.
  - COPY
```
public static final SaveFlags COPY
```
    Saves a copy of the document. Used with Incremental to create a new file from a binary copy of the input document.
  - LINEARIZED
```
public static final SaveFlags LINEARIZED
```
    Save in a format that is suitable for remote (network) access, Linearized is sometimes referred to as Web Optimized because of its goal of minimizing the perception of poor performance due to the number of pages in a document. This inherently uses OptimizeFonts, for documents with a large number of fonts, font optimization can have poor performance, see SaveLinearizedNoOptimizeFonts as an alternative.
  - COLLECT_GARBAGE
```
public static final SaveFlags COLLECT_GARBAGE
```
    Collect Garbage by removing unreferenced objects. Only valid with Full.
  - KEEP_MOD_DATE
```
public static final SaveFlags KEEP_MOD_DATE
```
    Do not update the Modification Date
  - CLOSE_AFTER_SAVE
```
public static final SaveFlags CLOSE_AFTER_SAVE
```
    Close document after save. Use this flag for saving to the stream only. Note that using this flag to save a document to any destination other than stream causes an exception.
  - XMPPACKET_READ_ONLY_NO_PADDING
```
public static final SaveFlags XMPPACKET_READ_ONLY_NO_PADDING
```
    Save XMP data as read-only without padding
  - UNCOMPRESSED
```
public static final SaveFlags UNCOMPRESSED
```
    Do not use object stream compression. Only valid with Full.
  - COMPRESSED
```
public static final SaveFlags COMPRESSED
```
    Use object compression wherever possible. Only valid with Full.
  - COMPRESS_STRUCTURE_ONLY
```
public static final SaveFlags COMPRESS_STRUCTURE_ONLY
```
    Use object compression only for Logical Structure items. Only valid with Full.
  - REMOVE_ASCIIFILTERS
```
public static final SaveFlags REMOVE_ASCIIFILTERS
```
    Remove the ASCII85 filter from all streams where its in use. Only valid with Full.
  - ADD_FLATE
```
public static final SaveFlags ADD_FLATE
```
    Encode any uncompressed stream witht the Flate filter. Only valid with Full.
  - REPLACE_LZW
```
public static final SaveFlags REPLACE_LZW
```
    Replace any LZW encoded stream with Flate. Only valid with Full.
  - OPTIMIZE_XOBJECTS
```
public static final SaveFlags OPTIMIZE_XOBJECTS
```
    Merge identical XObjects.
  - OPTIMIZE_CONTENT_STREAMS
```
public static final SaveFlags OPTIMIZE_CONTENT_STREAMS
```
    Optimize Content Streams operators where possible.
  - OPTIMIZE_FONTS
```
public static final SaveFlags OPTIMIZE_FONTS
```
    Merge Font Descriptors and encoding where possible. For documents with a large number of fonts, font optimization can have poor performance, this should only be set if necessary.
  - OPTIMIZE_MARKED_JBIG_2DICTIONARIES
```
public static final SaveFlags OPTIMIZE_MARKED_JBIG_2DICTIONARIES
```
    Delete symbols specific to JBIG2 Dictionaries that couldn't be removed previously.
  - ENSURE_7BIT_ASCII
```
public static final SaveFlags ENSURE_7BIT_ASCII
```
    Deprecated.
  - AUTO_SAVE
```
public static final SaveFlags AUTO_SAVE
```
    Deprecated.
  - DO_NOT_CREATE_TO_UNICODE_WIDTHS
```
public static final SaveFlags DO_NOT_CREATE_TO_UNICODE_WIDTHS
```
    Don't create /ToUnicode and /Widths entries for Fonts to improve performance.
  - SAVE_ORIGINAL_METADATA
```
public static final SaveFlags SAVE_ORIGINAL_METADATA
```
    Save original /Metadata stream of input as /Metadata stream of output document.
  - SAVE_LINEARIZED_NO_OPTIMIZE_FONTS
```
public static final SaveFlags SAVE_LINEARIZED_NO_OPTIMIZE_FONTS
```
    Save the document as Linearized the same as Linearized but OptimizeFonts is disabled. For documents with a large number of fonts, font optimization can have poor performance and is often unnecessary.
- Method Detail
  - values
```
public static SaveFlags[] 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 (SaveFlags c : SaveFlags.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SaveFlags 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

Enum SaveFlags

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INCREMENTAL

FULL

COPY

LINEARIZED

COLLECT_GARBAGE

KEEP_MOD_DATE

CLOSE_AFTER_SAVE

XMPPACKET_READ_ONLY_NO_PADDING

UNCOMPRESSED

COMPRESSED

COMPRESS_STRUCTURE_ONLY

REMOVE_ASCIIFILTERS

ADD_FLATE

REPLACE_LZW

OPTIMIZE_XOBJECTS

OPTIMIZE_CONTENT_STREAMS

OPTIMIZE_FONTS

OPTIMIZE_MARKED_JBIG_2DICTIONARIES

ENSURE_7BIT_ASCII

AUTO_SAVE

DO_NOT_CREATE_TO_UNICODE_WIDTHS

SAVE_ORIGINAL_METADATA

SAVE_LINEARIZED_NO_OPTIMIZE_FONTS

Method Detail

values

valueOf