[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.chart.ui / src / org / eclipse / tracecompass / internal / tmf / chart / ui / aggregator / IConsumerAggregator.java

/*******************************************************************************
 * Copyright (c) 2016 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package org.eclipse.tracecompass.internal.tmf.chart.ui.aggregator;

import java.util.function.Consumer;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.internal.tmf.chart.ui.consumer.IDataConsumer;
import org.eclipse.tracecompass.internal.tmf.chart.ui.consumer.NumericalConsumer;

/**
 * This interface is used for performing operations on multiple
 * {@link IDataConsumer}. As of right now, it is used for computing total range
 * of multiple {@link NumericalConsumer}. Normally, it should process the data
 * consumers only when they are done processing individual object from the
 * stream of data.
 *
 * FIXME: Find a better name. It consumes consumer, but it kind of seems
 * confusing calling it IConsumerConsumer.
 *
 * @author Gabriel-Andrew Pollo-Guilbert
 */
public interface IConsumerAggregator extends Consumer<@NonNull IDataConsumer> {

}
Commit	Line	Data
984fd447 GAPG	1	/*******************************************************************************
	2	* Copyright (c) 2016 École Polytechnique de Montréal
	3	*
	4	* All rights reserved. This program and the accompanying materials are
	5	* made available under the terms of the Eclipse Public License v1.0 which
	6	* accompanies this distribution, and is available at
	7	* http://www.eclipse.org/legal/epl-v10.html
	8	*******************************************************************************/
	9
	10	package org.eclipse.tracecompass.internal.tmf.chart.ui.aggregator;
	11
	12	import java.util.function.Consumer;
	13
	14	import org.eclipse.jdt.annotation.NonNull;
	15	import org.eclipse.tracecompass.internal.tmf.chart.ui.consumer.IDataConsumer;
	16	import org.eclipse.tracecompass.internal.tmf.chart.ui.consumer.NumericalConsumer;
	17
	18	/**
	19	* This interface is used for performing operations on multiple
	20	* {@link IDataConsumer}. As of right now, it is used for computing total range
	21	* of multiple {@link NumericalConsumer}. Normally, it should process the data
	22	* consumers only when they are done processing individual object from the
	23	* stream of data.
	24	*
	25	* FIXME: Find a better name. It consumes consumer, but it kind of seems
	26	* confusing calling it IConsumerConsumer.
	27	*
	28	* @author Gabriel-Andrew Pollo-Guilbert
	29	*/
	30	public interface IConsumerAggregator extends Consumer<@NonNull IDataConsumer> {
	31
	32	}