Top Description Fields Constructors Methods
org.apache.pdfbox.preflight

public Class PreflightConstants

extends Object
Class Inheritance

This interface provide a set of constants which identify validation error.

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final int
public static final String
public static final String
ERROR_ACTION_FORBIDDEN_ACTIONS

Common forbidden action error

public static final String
ERROR_ACTION_FORBIDDEN_ACTIONS_EXPLICITLY_FORBIDDEN

An explicitly forbidden action is used in the PDF file.

public static final String
ERROR_ACTION_FORBIDDEN_ACTIONS_NAMED

Named action other than predefined not allowed

public static final String
ERROR_ACTION_FORBIDDEN_ACTIONS_UNDEF

Actions is rejected if it isn't defined in the PDF Reference Third Edition This is to avoid not consistent file due to new features of the PDF format.

public static final String
ERROR_ACTION_FORBIDDEN_ADDITIONAL_ACTION

Additional action entry is forbidden

public static final String
ERROR_ACTION_FORBIDDEN_ADDITIONAL_ACTIONS_FIELD

Additional action entry is forbidden in a form field object

public static final String
ERROR_ACTION_FORBIDDEN_WIDGET_ACTION_FIELD

A widget annotation linked with a form field shall not have any action

public static final String
ERROR_ACTION_HIDE_H_INVALID

The H entry of a Hide action is set to true (so some annotation can be hide)

public static final String
ERROR_ACTION_INVALID_ACTIONS

Common invalid action error

public static final String
ERROR_ACTION_INVALID_TYPE

Some elements of the annotation dictionary have an invalid type (ex : array instead of Dictionary)

public static final String
public static final String
ERROR_ACTION_MISING_KEY

A mandatory entry in the action dictionary is missing

public static final String
ERROR_ACTION_MISSING_ACTION_DICTIONARY

An action validation is required but there are no element to validate

public static final String
ERROR_ANNOT_CATALOG_FORBIDDEN_AA

The AA field is forbidden for the Catalog when the PDF is a PDF/A

public static final String
ERROR_ANNOT_FORBIDDEN_AA

The AA field is forbidden for the Widget annotation when the PDF is a PDF/A

public static final String
ERROR_ANNOT_FORBIDDEN_COLOR

Annotation uses a Color profile which isn't the same than the profile contained by the OutputIntent

public static final String
ERROR_ANNOT_FORBIDDEN_DEST

Dest entry can't be used if the A element is used too

public static final String
ERROR_ANNOT_FORBIDDEN_ELEMENT

Common forbidden field error in annotation dictionary

public static final String
ERROR_ANNOT_FORBIDDEN_FLAG

The annotation uses a flag which is forbidden.

public static final String
ERROR_ANNOT_FORBIDDEN_SUBTYPE

This type of annotation is forbidden (ex : Movie)

public static final String
ERROR_ANNOT_INVALID_AP_CONTENT

The AP dictionary of the annotation contains forbidden/invalid entries (only the N entry is authorized)

public static final String
ERROR_ANNOT_INVALID_CA

Ca or/and ca entry are present but the value isn't 1.0

public static final String
ERROR_ANNOT_INVALID_DEST

Dest entry of an annotation can't be checked due to an IO Exception

public static final String
ERROR_ANNOT_INVALID_ELEMENT

Common Invalid field error in annotation dictionary

public static final String
public static final String
ERROR_ANNOT_MISSING_ANNOTATION_DICTIONARY

An annotation validation is required but there are no element to validate

public static final String
ERROR_ANNOT_MISSING_AP_N_CONTENT

The AP dictionary of the annotation contains forbidden/invalid entries (only the N entry is authorized)

public static final String
ERROR_ANNOT_MISSING_FIELDS

Common missing field error in annotation dictionary

public static final String
ERROR_ANNOT_MISSING_SUBTYPE

The subtype entry is missing from the annotation dictionary

public static final String
ERROR_FONTS_CHARSET_MISSING_FOR_SUBSET

Charset declaration is missing in a Type 1 Subset

public static final String
ERROR_FONTS_CID_CMAP_DAMAGED

The embedded CID Map is damaged

public static final String
ERROR_FONTS_CID_DAMAGED

The embedded composite font is damaged

public static final String
ERROR_FONTS_CIDKEYED_CIDTOGID

The CIDToGID is invalid

public static final String
ERROR_FONTS_CIDKEYED_CMAP_INVALID_OR_MISSING

The CMap of the Composite Font is missing or invalid

public static final String
ERROR_FONTS_CIDKEYED_INVALID

Required entry in a Composite Font dictionary is missing

public static final String
ERROR_FONTS_CIDKEYED_SYSINFO

The CIDSystemInfo dictionary is invalid

public static final String
ERROR_FONTS_CIDSET_MISSING_FOR_SUBSET

The CIDSet entry i mandatory from a subset of composite font

public static final String
ERROR_FONTS_DAMAGED

The embedded font is damaged

public static final String
ERROR_FONTS_DESCRIPTOR_INVALID

Some mandatory fields are missing from the FONT Descriptor Dictionary

public static final String
ERROR_FONTS_DICTIONARY_INVALID

Some mandatory fields are missing from the FONT Dictionary

public static final String
ERROR_FONTS_ENCODING

Encoding is inconsistent with the Font (ex : Symbolic TrueType mustn't declare encoding)

public static final String
ERROR_FONTS_ENCODING_ERROR

The CMap of the Composite Font is missing or invalid

public static final String
ERROR_FONTS_ENCODING_IO

Encoding entry can't be read due to IOException

public static final String
ERROR_FONTS_FONT_FILEX_INVALID

Error on the "Font File x" in the Font Descriptor (ex : FontFile and FontFile2 are present in the same dictionary)

public static final String
ERROR_FONTS_GLYPH

Common error for a Glyph problem

public static final String
ERROR_FONTS_GLYPH_MISSING

a glyph is missing

public static final String
public static final String
ERROR_FONTS_MAIN

Main error code for font problems

public static final String
ERROR_FONTS_METRICS

Width array and Font program Width are inconsistent

public static final String
ERROR_FONTS_TRUETYPE_DAMAGED

The embedded TrueType font is damaged

public static final String
ERROR_FONTS_TYPE1_DAMAGED

The embedded Type1 font is damaged

public static final String
ERROR_FONTS_TYPE3_DAMAGED

The embedded type 3 font is damaged

public static final String
ERROR_FONTS_UNKNOWN_FONT_REF

a glyph is missing

public static final String
ERROR_FONTS_UNKNOWN_FONT_TYPE

The font type is unknown

public static final String
public static final String
ERROR_GRAPHIC_INVALID_BBOX

BBox Entry of a Form XObject is missing or isn't an Array

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE

An invalid color space is used

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_ALTERNATE

alternate color space used in the PDF file but the DestOutputProfile isn't consistent

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_CMYK

CMYK color space used in the PDF file but the DestOutputProfile isn't CMYK

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_FORBIDDEN

ColorSpace is forbidden due to some restriction (ex : Only DeviceXXX are auth in inlined image)

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_ICCBASED

ICC Based color space used in the PDF file is invalid

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_INDEXED

Base ColorSpace in the Indexed color space is invalid

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_MISSING

color space used in the PDF file but the DestOutputProfile is missing

public static final String
ERROR_GRAPHIC_INVALID_COLOR_SPACE_RGB

RGB color space used in the PDF file but the DestOutputProfile isn't RGB

public static final String
public static final String
ERROR_GRAPHIC_INVALID_PATTERN_COLOR_SPACE_FORBIDDEN

The pattern color space can't be used

public static final String
ERROR_GRAPHIC_INVALID_PATTERN_DEFINITION

The pattern is invalid due to missing key or invalid value

public static final String
public static final String
ERROR_GRAPHIC_MAIN

Main error code for graphical problems

public static final String
ERROR_GRAPHIC_MISSING_COLOR_SPACE_ICCBASED

Validation asked on a missing ColorSpace

public static final String
public static final String
public static final String
public static final String
ERROR_GRAPHIC_OUTPUT_INTENT_ICC_PROFILE_MULTIPLE

There are more than one ICC Profile

public static final String
ERROR_GRAPHIC_OUTPUT_INTENT_ICC_PROFILE_TOO_RECENT

Profile version is too recent for PDF 1.4 document

public static final String
ERROR_GRAPHIC_OUTPUT_INTENT_INVALID_ENTRY

The OutputIntent dictionary is invalid

public static final String
ERROR_GRAPHIC_OUTPUT_INTENT_S_VALUE_INVALID

The S entry of the OutputIntent isn't GTS_PDFA1

public static final String
public static final String
ERROR_GRAPHIC_TRANSPARENCY

Main error code for graphical transparency problems

public static final String
ERROR_GRAPHIC_TRANSPARENCY_GROUP

A Group entry with S = Transparency is used or the S = Null

public static final String
ERROR_GRAPHIC_TRANSPARENCY_SMASK

A XObject SMask value isn't None

public static final String
ERROR_GRAPHIC_UNEXPECTED_KEY

A XObject has an unexpected key defined

public static final String
ERROR_GRAPHIC_UNEXPECTED_VALUE_FOR_KEY

A XObject has an unexpected value for a defined key

public static final String
public static final String
ERROR_METADATA_ABSENT_DESCRIPTION_SCHEMA

Description schema required not embedded

public static final String
ERROR_METADATA_CATEGORY_PROPERTY_INVALID

a category has an invalid value in one property description (must be internal or external)

public static final String
ERROR_METADATA_DICT_INFO_CORRUPT

the info dictionary is corrupt or value can't be read

public static final String
ERROR_METADATA_FORMAT

Invalid metadata found

public static final String
ERROR_METADATA_FORMAT_STREAM

Invalid metadata, unable to process the font due to IOException

public static final String
ERROR_METADATA_FORMAT_UNKNOWN

Unexpected type of a Metadata entry

public static final String
ERROR_METADATA_FORMAT_XPACKET

Invalid metadata, unable to process the font due to Invalid XPacket exception

public static final String
ERROR_METADATA_INVALID_PDFA_CONFORMANCE

PDF/A Identification Conformance Invalid

public static final String
ERROR_METADATA_INVALID_PDFA_VERSION_ID

PDF/A Identification Version Identifier Invalid (pdfaid:part)

public static final String
ERROR_METADATA_MAIN

Main metadata error code

public static final String
ERROR_METADATA_MISMATCH

Metadata mismatch between PDF Dictionary and xmp

public static final String
ERROR_METADATA_NS_URI_MISSING

A required namespace URI missing

public static final String
ERROR_METADATA_PDFA_ID_MISSING

PDF/A Identification Schema not found

public static final String
ERROR_METADATA_PROPERTY_FORMAT

Invalid xmp metadata format

public static final String
ERROR_METADATA_PROPERTY_MISSING

Required property is missing

public static final String
public static final String
ERROR_METADATA_RDF_ABOUT_ATTRIBUTE_INEQUAL_VALUE

One of rdf:about attribute embedded in RDF:rdf have a different value than the others

public static final String
public static final String
ERROR_METADATA_UNKNOWN_VALUETYPE

A valueType is used but is not declared

public static final String
ERROR_METADATA_WRONG_NS_PREFIX

A namespace prefix has an unexpected value

public static final String
ERROR_METADATA_WRONG_NS_URI

A namespace URI has an unexpected value

public static final String
ERROR_METADATA_XPACKET_DEPRECATED

Invalid information in xpacket processing instruction

public static final String
ERROR_PDF_PROCESSING

Error about PDF processing : that is not necessary a specific PDF/A validation error but a PDF specification requirement that isn't respected.

public static final String
ERROR_PDF_PROCESSING_MISSING

A Mandatory element is missing

public static final String
ERROR_SYNTAX_ARRAY_TOO_LONG

Too many element in an array object

public static final String
ERROR_SYNTAX_BODY

Common error about body syntax

public static final String
public static final String
public static final String
ERROR_SYNTAX_CONTENT_STREAM_INVALID

The content stream has some syntax errors

public static final String
ERROR_SYNTAX_CONTENT_STREAM_INVALID_ARGUMENT

The content stream contains an invalid argument for the operator

public static final String
ERROR_SYNTAX_CONTENT_STREAM_UNSUPPORTED_OP

The content stream uses an unsupported operator

public static final String
ERROR_SYNTAX_CROSS_REF

Common error about the cross ref table

public static final String
ERROR_SYNTAX_DICT_INVALID

Required fields are missing from the dictionary

public static final String
ERROR_SYNTAX_DICTIONARY_KEY_INVALID

A dictionary key isn't a name

public static final String
ERROR_SYNTAX_EMBEDDED_FILES

EmbeddedFile entry is present in a FileSpecification dictionary

public static final String
public static final String
public static final String
public static final String
ERROR_SYNTAX_HEXA_STRING_EVEN_NUMBER

Hexa string shall contain even number of non white space char

public static final String
ERROR_SYNTAX_HEXA_STRING_INVALID

Hexa string contain non hexadecimal characters

public static final String
ERROR_SYNTAX_HEXA_STRING_TOO_LONG

The hexa string is too long

public static final String
ERROR_SYNTAX_INDIRECT_OBJ_RANGE

There are too many objects

public static final String
ERROR_SYNTAX_INVALID_OFFSET

An object has an invalid offset

public static final String
ERROR_SYNTAX_LANG_NOT_RFC1766

The language declared doesn't match with the RFC1766

public static final String
ERROR_SYNTAX_LITERAL_TOO_LONG

The literal string is too long

public static final String
ERROR_SYNTAX_MAIN

Error code for syntax error

public static final String
ERROR_SYNTAX_MISSING_OFFSET

An object is missing from the document

public static final String
ERROR_SYNTAX_NAME_TOO_LONG

The name length is too long

public static final String
ERROR_SYNTAX_NOCATALOG

There are no catalog dictionary in the PDF File

public static final String
ERROR_SYNTAX_NUMERIC_RANGE

The number is out of Range ( ex : greater than 2^31-1)

public static final String
ERROR_SYNTAX_OBJ_DELIMITER

Error on the object delimiters (obj / endobj)

public static final String
ERROR_SYNTAX_STREAM_DAMAGED

The stream can't be processed

public static final String
ERROR_SYNTAX_STREAM_DELIMITER

Error on the stream delimiters (stream / endstream)

public static final String
ERROR_SYNTAX_STREAM_FX_KEYS

F or/and FFilter or/and FDecodeParms are present in a stream dictionary

public static final String
ERROR_SYNTAX_STREAM_INVALID_FILTER

The stream uses an invalid filter (The LZW)

public static final String
ERROR_SYNTAX_STREAM_LENGTH_INVALID

The length of the stream dictionary and the stream length is inconsistent

public static final String
ERROR_SYNTAX_STREAM_LENGTH_MISSING

The length entry is missing from the stream dictionary

public static final String
ERROR_SYNTAX_STREAM_UNDEFINED_FILTER

The stream uses a filter which isn't defined in the PDF Reference document.

public static final String
ERROR_SYNTAX_TOO_MANY_ENTRIES

Too many entries in a dictionary object

public static final String
ERROR_SYNTAX_TRAILER

Common error about the trailer

public static final String
ERROR_SYNTAX_TRAILER_CATALOG_EMBEDDEDFILES

EmbeddedFile entry is present in the Names dictionary

public static final String
ERROR_SYNTAX_TRAILER_CATALOG_OCPROPERTIES

Optional content is forbidden

public static final String
ERROR_SYNTAX_TRAILER_ENCRYPT

Encrypt is forbidden

public static final String
ERROR_SYNTAX_TRAILER_EOF

Last %%EOF sequence is followed by data

public static final String
ERROR_SYNTAX_TRAILER_ID_CONSISTENCY

ID in 1st trailer and the last is different

public static final String
ERROR_SYNTAX_TRAILER_MISSING_ID

ID is missing from the trailer

public static final String
ERROR_SYNTAX_TRAILER_MISSING_ROOT

Root is missing from the trailer

public static final String
ERROR_SYNTAX_TRAILER_MISSING_SIZE

Size is missing from the trailer

public static final String
ERROR_SYNTAX_TRAILER_OUTLINES_INVALID

Errors in the Outlines dictionary

public static final String
ERROR_SYNTAX_TRAILER_TYPE_INVALID

An trailer entry has an invalid type

public static final String
ERROR_TRANSPARENCY_EXT_GRAPHICAL_STATE

Common transparency error

public static final String
ERROR_TRANSPARENCY_EXT_GS_BLEND_MODE

BlendMode value isn't valid (only Normal and Compatible are authorized)

public static final String
ERROR_TRANSPARENCY_EXT_GS_CA

Ca or/and ca entry are present but the value isn't 1.0

public static final String
ERROR_TRANSPARENCY_EXT_GS_SOFT_MASK

Soft mask entry is present but is forbidden

public static final String
public static final String
ERROR_UNKNOWN_ERROR

Error code uses by the Validator when there is an error without error code.

public static final int
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final float
public static final float
public static final int
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait