Package org.apache.pdfbox.preflight
Class ValidationResult
java.lang.Object
org.apache.pdfbox.preflight.ValidationResult
Object returned by the validate method of the PDFValidator. This object contains a boolean to know if the PDF is
PDF/A-1x compliant. If the document isn't PDF/A-1x a list of errors is provided.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This Class represents an error of validation. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Boolean to know if the PDF is a valid PDF/Aprivate List<ValidationResult.ValidationError>
Errors to know why the PDF isn't valid.private XMPMetadata
Object representation of the XMPMetaData contained by the pdf file This attribute can be null if the Validation fails. -
Constructor Summary
ConstructorsConstructorDescriptionValidationResult
(boolean isValid) Create a Validation result objectCreate a Validation Result object.Create a Validation Result object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add error to the list of ValidationError.void
Add a set of errors to the list of ValidationError.boolean
isValid()
void
mergeResult
(ValidationResult otherResult) Add the ValidationError object of the otherResult in the Error list of the current object.(package private) void
setXmpMetaData
(XMPMetadata xmpMetaData)
-
Field Details
-
isValid
private boolean isValidBoolean to know if the PDF is a valid PDF/A -
lErrors
Errors to know why the PDF isn't valid. If the PDF is valid, this list is empty. -
xmpMetaData
Object representation of the XMPMetaData contained by the pdf file This attribute can be null if the Validation fails.
-
-
Constructor Details
-
ValidationResult
public ValidationResult(boolean isValid) Create a Validation result object- Parameters:
isValid
-
-
ValidationResult
Create a Validation Result object. This constructor force the isValid to false and add the given error to the list or ValidationErrors.- Parameters:
error
- if error is null, no error is added to the list.
-
ValidationResult
Create a Validation Result object. This constructor force the isValid to false and add all the given errors to the list or ValidationErrors.- Parameters:
errors
- if error is null, no error is added to the list.
-
-
Method Details
-
mergeResult
Add the ValidationError object of the otherResult in the Error list of the current object. Apply a logical AND on the isValid boolean.- Parameters:
otherResult
-
-
getXmpMetaData
- Returns:
- the xmpMetaData
-
setXmpMetaData
- Parameters:
xmpMetaData
- the xmpMetaData to set
-
isValid
public boolean isValid()- Returns:
- true if the PDF is valid,false otherwise
-
addError
Add error to the list of ValidationError. If the given error is null, this method does nothing- Parameters:
error
-
-
addErrors
Add a set of errors to the list of ValidationError. If the given list is null, this method does nothing.- Parameters:
errors
-
-
getErrorsList
- Returns:
- the list of validation errors
-