com.itextpdf.commons.actions.producer.CopyrightToPlaceholderPopulator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation
There is a newer version: 8.0.5
/*
    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.commons.actions.producer;

import com.itextpdf.commons.actions.confirmations.ConfirmedEventWrapper;
import com.itextpdf.commons.exceptions.CommonsExceptionMessageConstant;
import com.itextpdf.commons.utils.MessageFormatUtil;

import java.util.List;

/**
 * Class is used to populate copyrightTo placeholder. The resulting string is a
 * representation of the last year of copyright years range. Among all products involved into
 * product creation the latest copyrightTo year is picked as a resulting value
 */
class CopyrightToPlaceholderPopulator implements IPlaceholderPopulator {

    public CopyrightToPlaceholderPopulator() {
        // Empty constructor.
    }

    /**
     * Builds a replacement for a placeholder copyrightTo in accordance with the
     * registered events.
     *
     * @param events is a list of event involved into document processing. It is expected that it
     *               is not empty as such cases should be handled by {@link ProducerBuilder} without
     *               calling any {@link IPlaceholderPopulator}
     * @param parameter is a parameter for the placeholder. It should be null as
     *                  copyrightTo as the placeholder is not configurable
     *
     * @return the latest copyright year
     *
     * @throws IllegalArgumentException if parameter is not null
     */
    @Override
    public String populate(List events, String parameter) {

        if (parameter != null) {
            throw new IllegalArgumentException(MessageFormatUtil.format(
                    CommonsExceptionMessageConstant.INVALID_USAGE_CONFIGURATION_FORBIDDEN, "copyrightTo")
            );
        }

        // initial value, will be overwritten with product value
        int latestYear = Integer.MIN_VALUE;
        for (ConfirmedEventWrapper event : events) {
            int currentYear = event.getEvent().getProductData().getToCopyrightYear();
            if (currentYear > latestYear) {
                latestYear = currentYear;
            }
        }
        return String.valueOf(latestYear);
    }
}