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

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2021 iText Group NV
    Authors: iText 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 java.util.List;

/**
 * Interface for placeholder population.
 */
interface IPlaceholderPopulator {
    /**
     * Populates a placeholder based on the list of {@link ConfirmedEventWrapper}
     * and the array of parts of placeholder.
     *
     * @param events is a list of event involved into document processing
     * @param parameter is a parameter passed to a placeholder and separated via delimiter :
     *
     * @return value for placeholder replacement
     */
    String populate(List events, String parameter);
}