com.itextpdf.commons.actions.AbstractStatisticsAggregator Maven / Gradle / Ivy

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-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;

/**
 * Abstract class for statistics aggregation. Note that aggregator class must be thread safe.
 */
public abstract class AbstractStatisticsAggregator {

    /**
     * Aggregates data from the provided event.
     *
     * @param event {@link AbstractStatisticsEvent} instance
     */
    public abstract void aggregate(AbstractStatisticsEvent event);

    /**
     * Retrieves aggregated data.
     *
     * @return aggregated data as {@link Object}
     */
    public abstract Object retrieveAggregation();

    /**
     * Merges data from the provided aggregator into this aggregator.
     *
     * @param aggregator from which data will be taken.
     */
    public abstract void merge(AbstractStatisticsAggregator aggregator);
}