com.itextpdf.kernel.pdf.DocumentInfoHelper 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

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;

/**
 * The class is helper which used inside {@link PdfDocument} to properly configure PDF document's info dictionary.
 */
public class DocumentInfoHelper {
    /**
     * If document info dictionary should be added to the trailer.
     *
     * @return {@code true} if should be added, otherwise {@code false}
     */
    public boolean shouldAddDocumentInfoToTrailer() {
        return true;
    }

    /**
     * Adjusts document info before it's flushing and adding to the trailer
     * if required, see {@link #shouldAddDocumentInfoToTrailer()}.
     *
     * @param documentInfo the {@link PdfDocumentInfo} instance to adjust
     */
    public void adjustDocumentInfo(PdfDocumentInfo documentInfo) {
        // do nothing
    }
}