com.itextpdf.kernel.utils.ValidationContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kernel-android Show documentation
There is a newer version: 9.0.0
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.kernel.utils;

import com.itextpdf.kernel.pdf.IsoKey;
import com.itextpdf.kernel.pdf.PdfResources;
import com.itextpdf.kernel.pdf.PdfStream;

import java.util.ArrayList;
import java.util.List;

/**
 * This class is a container for one or more {@link IValidationChecker} implementations.
 * 
 *
 * It is used in the {@link com.itextpdf.kernel.pdf.PdfDocument} to check for additional conformance requirements.
 */
public class ValidationContainer {

    private final List validationCheckers;

    /**
     * Create a new {@link ValidationContainer} instance.
     * 

     *
     * By default, no {@link IValidationChecker} implementations are added.
     */
    public ValidationContainer() {
        this.validationCheckers = new ArrayList<>();
    }

    /**
     * Validate the provided {@link ValidationContext} with all the {@link IValidationChecker} implementations.
     * 

     *
     * @param context the {@link ValidationContext} to validate
     */
    public void validate(ValidationContext context) {
        for (IValidationChecker checker : validationCheckers) {
            checker.validateDocument(context);
        }
    }

    /**
     * Check the provided object for conformance with all the {@link IValidationChecker} implementations.
     * 
     *
     * @param obj           the object to check
     * @param key           the {@link IsoKey} of the object
     * @param resources     the {@link PdfResources} of the object
     * @param contentStream the {@link PdfStream} of the object
     * @param extra         additional information
     */
    public void validate(Object obj, IsoKey key, PdfResources resources, PdfStream contentStream,
            Object extra) {
        for (IValidationChecker checker : validationCheckers) {
            checker.validateObject(obj, key, resources, contentStream, extra);
        }
    }

    /**
     * Add an {@link IValidationChecker} implementation to the container.
     *
     * @param checker the {@link IValidationChecker} implementation to add
     */
    public void addChecker(IValidationChecker checker) {
        validationCheckers.add(checker);
    }


    /**
     * Check if the container contains the provided {@link IValidationChecker} implementation.
     *
     * @param checker the {@link IValidationChecker} implementation to check
     * @return {@code true} if the container contains the provided {@link IValidationChecker} implementation,
     * {@code false} otherwise
     */
    public boolean containsChecker(IValidationChecker checker) {
        return validationCheckers.contains(checker);
    }

}