tmf/org.eclipse.tracecompass.tmf.chart.ui/src/org/eclipse/tracecompass/internal/tmf/chart/ui/consumer/ISeriesConsumer.java

   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.consumer;
  11
  12 import java.util.function.Consumer;
  13
  14 /**
  15  * This interface consumes any data that comes from a {@link IChartConsumer}.
  16  * Every object that it receives is sent to its own {@link IDataConsumer}. The
  17  * main benefit of this consumer is that it can easily reject (x, y) couple that
  18  * are invalid for plotting. An object can be tested with
  19  * {@link IDataConsumer#test(Object)} before being consumed into an (x, y)
  20  * couple.
  21  * <p>
  22  * For example, a XY chart should have a series consumer for each of the plotted
  23  * series. There would have two consumer in a XY chart that plot the following
  24  * series: "start VS name" and "end VS name".
  25  *
  26  * @see IChartConsumer
  27  * @see IDataConsumer
  28  *
  29  * @author Gabriel-Andrew Pollo-Guilbert
  30  */
  31 public interface ISeriesConsumer extends Consumer<Object> {
  32
  33 }