StampingProperties.java

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2025 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 <https://www.gnu.org/licenses/>.
 */
package com.itextpdf.kernel.pdf;

/**
 * Class with additional properties for {@link PdfDocument} processing
 * in stamping mode. Needs to be passed at document initialization.
 *
 * <p>
 * See {@link PageFlushingHelper} documentation to find more information about modes of document processing.
 */
public class StampingProperties extends DocumentProperties {
    protected boolean appendMode = false;
    protected boolean preserveEncryption = false;
    protected boolean disableMac = false;

    /**
     * Default constructor, use provided setters for configuration options.
     */
    public StampingProperties() {
        // Do nothing
    }

    /**
     * Creates a copy of class instance.
     *
     * @param other the base for new class instance
     */
    public StampingProperties(StampingProperties other) {
        super(other);
        this.appendMode = other.appendMode;
        this.preserveEncryption = other.preserveEncryption;
        this.disableMac = other.disableMac;
    }

    /**
     * Creates a copy of {@link DocumentProperties} instance.
     *
     * @param documentProperties the base for new class instance
     */
    StampingProperties(DocumentProperties documentProperties) {
        super(documentProperties);
        this.dependencies = documentProperties.dependencies;
    }

    /**
     * Defines if the document will be edited in append mode.
     *
     * @return this {@link StampingProperties} instance
     */
    public StampingProperties useAppendMode() {
        appendMode = true;
        return this;
    }

    /**
     * Defines if the encryption of the original document (if it was encrypted) will be preserved.
     * By default, the resultant document doesn't preserve the original encryption.
     *
     * @return this {@link StampingProperties} instance
     */
    public StampingProperties preserveEncryption() {
        this.preserveEncryption = true;
        return this;
    }

    /**
     * Disables MAC token in the output PDF-2.0 document.
     * By default, MAC token will be embedded.
     * This property does not remove MAC token from existing document in append mode because it removes MAC protection
     * from all previous revisions also.
     *
     * @return this {@link StampingProperties} instance
     */
    public StampingProperties disableMac() {
        this.disableMac = true;
        return this;
    }
}