com.itextpdf.kernel.utils.annotationsflattening.NotSupportedFlattener 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-2023 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.annotationsflattening;

import com.itextpdf.commons.utils.MessageFormatUtil;
import com.itextpdf.kernel.logs.KernelLogMessageConstant;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.annot.PdfAnnotation;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is used to warn that annotation flattening is not supported for the given annotation.
 */
public class NotSupportedFlattener implements IAnnotationFlattener {

    private static final Logger LOGGER = LoggerFactory.getLogger(NotSupportedFlattener.class);

    /**
     * Creates a new {@link NotSupportedFlattener} instance.
     */
    public NotSupportedFlattener() {
        //empty constructor
    }

    /**
     * Logs a warning that annotation flattening is not supported for the given annotation.
     *
     * @param annotation annotation to flatten
     * @param page       page to flatten annotation on
     *
     * @return true if annotation was flattened, false otherwise
     */
    @Override
    public boolean flatten(PdfAnnotation annotation, PdfPage page) {
        final String message = MessageFormatUtil.format(KernelLogMessageConstant.FLATTENING_IS_NOT_YET_SUPPORTED,
                annotation.getSubtype());
        LOGGER.warn(message);
        return false;
    }
}