001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.functor.aggregator;
018
019/**
020 * Listener to be used with instances of {@link AbstractTimedAggregator} to
021 * receive notifications when the timer kicks in.
022 *
023 * @param <T>
024 *            Type of object the <code>Aggregator</code> is operating on.
025 */
026public interface TimedAggregatorListener<T> {
027    /**
028     * Received when the aggregator listening to has triggered the timer.
029     *
030     * @param aggregator
031     *            Aggregator which has triggered the time event in the first
032     *            place.
033     * @param evaluation
034     *            Current {@link AbstractTimedAggregator#evaluate() evaluation
035     *            result} of the aggregator which triggered the event
036     */
037    void onTimer(AbstractTimedAggregator<T> aggregator, T evaluation);
038}