Package org.apache.pdfbox.preflight
Class PreflightConfiguration
- java.lang.Object
-
- org.apache.pdfbox.preflight.PreflightConfiguration
-
public class PreflightConfiguration extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACRO_FORM_PROCESSstatic java.lang.StringACTIONS_PROCESSstatic java.lang.StringANNOTATIONS_PROCESSstatic java.lang.StringBOOKMARK_PROCESSstatic java.lang.StringCATALOG_PROCESSstatic java.lang.StringDESTINATION_PROCESSstatic java.lang.StringEXTGSTATE_PROCESSstatic java.lang.StringFILE_SPECIF_PROCESSstatic java.lang.StringFONT_PROCESSstatic java.lang.StringGRAPHIC_PROCESSstatic java.lang.StringMETA_DATA_PROCESSstatic java.lang.StringPAGE_PROCESSstatic java.lang.StringPAGES_TREE_PROCESSstatic java.lang.StringRESOURCES_PROCESSstatic java.lang.StringSHADING_PATTERN_PROCESSstatic java.lang.StringSTREAM_PROCESSstatic java.lang.StringTILING_PATTERN_PROCESSstatic java.lang.StringTRAILER_PROCESSstatic java.lang.StringXREF_PROCESS
-
Constructor Summary
Constructors Constructor Description PreflightConfiguration()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PreflightConfigurationcreatePdfA1BConfiguration()ActionManagerFactorygetActionFact()AnnotationValidatorFactorygetAnnotFact()ColorSpaceHelperFactorygetColorSpaceHelperFact()ValidationProcessgetInstanceOfProcess(java.lang.String processName)Return the validation process linked with the given nameintgetMaxErrors()Get the maximum number of errors after which to abort when possible.java.util.Collection<java.lang.String>getPageValidationProcessNames()java.util.Collection<java.lang.String>getProcessNames()booleanisErrorOnMissingProcess()booleanisLazyValidation()voidremovePageProcess(java.lang.String processName)voidremoveProcess(java.lang.String processName)voidreplacePageProcess(java.lang.String processName, java.lang.Class<? extends ValidationProcess> process)voidreplaceProcess(java.lang.String processName, java.lang.Class<? extends ValidationProcess> process)voidsetActionFact(ActionManagerFactory actionFact)voidsetAnnotFact(AnnotationValidatorFactory annotFact)voidsetColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)voidsetErrorOnMissingProcess(boolean errorOnMissingProcess)voidsetLazyValidation(boolean lazyValidation)voidsetMaxErrors(int maxErrors)Set the maximum number of errors after which to abort when possible.
-
-
-
Field Detail
-
CATALOG_PROCESS
public static final java.lang.String CATALOG_PROCESS
- See Also:
- Constant Field Values
-
STREAM_PROCESS
public static final java.lang.String STREAM_PROCESS
- See Also:
- Constant Field Values
-
TRAILER_PROCESS
public static final java.lang.String TRAILER_PROCESS
- See Also:
- Constant Field Values
-
XREF_PROCESS
public static final java.lang.String XREF_PROCESS
- See Also:
- Constant Field Values
-
BOOKMARK_PROCESS
public static final java.lang.String BOOKMARK_PROCESS
- See Also:
- Constant Field Values
-
ACRO_FORM_PROCESS
public static final java.lang.String ACRO_FORM_PROCESS
- See Also:
- Constant Field Values
-
FILE_SPECIF_PROCESS
public static final java.lang.String FILE_SPECIF_PROCESS
- See Also:
- Constant Field Values
-
PAGES_TREE_PROCESS
public static final java.lang.String PAGES_TREE_PROCESS
- See Also:
- Constant Field Values
-
META_DATA_PROCESS
public static final java.lang.String META_DATA_PROCESS
- See Also:
- Constant Field Values
-
PAGE_PROCESS
public static final java.lang.String PAGE_PROCESS
- See Also:
- Constant Field Values
-
RESOURCES_PROCESS
public static final java.lang.String RESOURCES_PROCESS
- See Also:
- Constant Field Values
-
ACTIONS_PROCESS
public static final java.lang.String ACTIONS_PROCESS
- See Also:
- Constant Field Values
-
ANNOTATIONS_PROCESS
public static final java.lang.String ANNOTATIONS_PROCESS
- See Also:
- Constant Field Values
-
GRAPHIC_PROCESS
public static final java.lang.String GRAPHIC_PROCESS
- See Also:
- Constant Field Values
-
FONT_PROCESS
public static final java.lang.String FONT_PROCESS
- See Also:
- Constant Field Values
-
EXTGSTATE_PROCESS
public static final java.lang.String EXTGSTATE_PROCESS
- See Also:
- Constant Field Values
-
SHADING_PATTERN_PROCESS
public static final java.lang.String SHADING_PATTERN_PROCESS
- See Also:
- Constant Field Values
-
TILING_PATTERN_PROCESS
public static final java.lang.String TILING_PATTERN_PROCESS
- See Also:
- Constant Field Values
-
DESTINATION_PROCESS
public static final java.lang.String DESTINATION_PROCESS
- See Also:
- Constant Field Values
-
-
Method Detail
-
createPdfA1BConfiguration
public static PreflightConfiguration createPdfA1BConfiguration()
-
getProcessNames
public java.util.Collection<java.lang.String> getProcessNames()
-
getInstanceOfProcess
public ValidationProcess getInstanceOfProcess(java.lang.String processName) throws ValidationException
Return the validation process linked with the given name- Parameters:
processName-- Returns:
- an instance of validationProcess, null if it doesn't exist and if the errorOnMissingProcess is false.
- Throws:
MissingValidationProcessException- if the Process doesn't exist (errorOnMissingProcess is true).ValidationException- if the process instance can't be created.
-
replaceProcess
public void replaceProcess(java.lang.String processName, java.lang.Class<? extends ValidationProcess> process)
-
removeProcess
public void removeProcess(java.lang.String processName)
-
getPageValidationProcessNames
public java.util.Collection<java.lang.String> getPageValidationProcessNames()
-
replacePageProcess
public void replacePageProcess(java.lang.String processName, java.lang.Class<? extends ValidationProcess> process)
-
removePageProcess
public void removePageProcess(java.lang.String processName)
-
isErrorOnMissingProcess
public boolean isErrorOnMissingProcess()
-
setErrorOnMissingProcess
public void setErrorOnMissingProcess(boolean errorOnMissingProcess)
-
isLazyValidation
public boolean isLazyValidation()
-
setLazyValidation
public void setLazyValidation(boolean lazyValidation)
-
getAnnotFact
public AnnotationValidatorFactory getAnnotFact()
-
setAnnotFact
public void setAnnotFact(AnnotationValidatorFactory annotFact)
-
getActionFact
public ActionManagerFactory getActionFact()
-
setActionFact
public void setActionFact(ActionManagerFactory actionFact)
-
getColorSpaceHelperFact
public ColorSpaceHelperFactory getColorSpaceHelperFact()
-
setColorSpaceHelperFact
public void setColorSpaceHelperFact(ColorSpaceHelperFactory colorSpaceHelperFact)
-
getMaxErrors
public int getMaxErrors()
Get the maximum number of errors after which to abort when possible.- Returns:
-
setMaxErrors
public void setMaxErrors(int maxErrors)
Set the maximum number of errors after which to abort when possible.- Parameters:
maxErrors-
-
-