View Javadoc

1   /*
2    * Copyright (c) 2003-2008 by Cosylab d. d.
3    *
4    * This file is part of CosyBeans.
5    *
6    * CosyBeans is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * CosyBeans is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with CosyBeans.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  package com.cosylab.gui.displayers;
21  
22  import com.cosylab.util.CommonException;
23  
24  
25  /**
26   * <code>NumberConsumer</code> is data consumer for receiveing updates of
27   * <code>Number</code> dynamic values, which will block call until update is
28   * completer and throws exception on fail.
29   * 
30   * <p>
31   * This interface is intended to be used by <code>DataSource</code>. Displayer
32   * which want to notify data source about value changes done by user need to
33   * implement <code>DataSource</code> which supports this type of consumer.
34   * </p>
35   *
36   * @author <a href="mailto:igor.kriznar@cosylab.com">Igor Kriznar</a>
37   * @version $Id: SynchronousNumberConsumer.java,v 1.3 2008-04-22 12:31:02 jbobnar Exp $
38   *
39   * @since Nov 24, 2003.
40   */
41  public interface SynchronousNumberConsumer extends DataConsumer
42  {
43  	/**
44  	 * Notifys this consumer about new dynamic value update.
45  	 *
46  	 * @param timestamp the time of dynamic value event
47  	 * @param value new value
48  	 */
49  	public void updateSynchronously(long timestamp, Number value)
50  		throws CommonException;
51  }
52  
53  /* __oOo__ */