com.itextpdf.kernel.pdf.DocumentProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kernel Show documentation
The newest version!
/*
    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.pdf;

import com.itextpdf.commons.actions.contexts.IMetaInfo;

/**
 * Class with additional properties for {@link PdfDocument} processing.
 * Needs to be passed at document initialization.
 */
public class DocumentProperties {


    protected IMetaInfo metaInfo = null;

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

    /**
     * Creates a copy of class instance.
     *
     * @param other the base for new class instance
     */
    public DocumentProperties(DocumentProperties other) {
        this.metaInfo = other.metaInfo;
    }

    /**
     * Sets document meta info.
     *
     * @param metaInfo meta info to set
     * @return this {@link DocumentProperties} instance
     */
    public DocumentProperties setEventCountingMetaInfo(IMetaInfo metaInfo) {
        this.metaInfo = metaInfo;
        return this;
    }

    /**
     * Checks if the document event counting meta info was already set.
     *
     * @return true if the document event counting meta info is set, false otherwise.
     */
    public boolean isEventCountingMetaInfoSet() {
        return this.metaInfo != null;
    }
}