View Javadoc

1   /*
2   Copyright (C) 2007 Dirk Huenniger
3   
4   This library is free software; you can redistribute it and/or
5   modify it under the terms of the GNU Lesser General Public
6   License as published by the Free Software Foundation; either
7   version 2.1 of the License, or (at your option) any later version.
8   
9   This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  Lesser General Public License for more details.
13  
14  You should have received a copy of the GNU Lesser General Public
15  License along with this library; if not, write to the Free Software
16  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17   */
18  package org.indi.reactor;
19  
20  import java.util.Queue;
21  
22  /**
23   * A callback handler. To be called by the reactor whenever there is an element
24   * in is found in the queue.
25   * 
26   * @author Dirk Hünniger
27   * @param <T>
28   *                The type of Object to be put into the Queue
29   */
30  public interface QueueHandler<T> {
31      /**
32       * @return The Queue the Handler is associated with
33       */
34      public Queue<T> getQueue();
35  
36      /**
37       * Called by the reactor whenever an element is found in the queue
38       * 
39       * @param The
40       *                head element found in the queue.
41       */
42      public void onRead(T input);
43  }