View Javadoc

1   /***
2    * Redistribution  and use  in source  and binary  forms, with  or without
3    * modification, are permitted provided  that the following conditions are
4    * met :
5    *
6    * . Redistributions  of  source  code  must  retain  the  above copyright
7    *   notice, this list of conditions and the following disclaimer.
8    *
9    * . Redistributions in  binary form  must reproduce  the above  copyright
10   *   notice, this list of conditions  and the following disclaimer in  the
11   *   documentation and/or other materials provided with the distribution.
12   *
13   * . The name of the author may not be used to endorse or promote products
14   *   derived from this software without specific prior written permission.
15   *
16   * THIS SOFTWARE IS  PROVIDED BY THE  AUTHOR ``AS IS''  AND ANY EXPRESS  OR
17   * IMPLIED  WARRANTIES,  INCLUDING,  BUT   NOT  LIMITED  TO,  THE   IMPLIED
18   * WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE ARE
19   * DISCLAIMED.  IN NO  EVENT SHALL  THE AUTHOR  BE LIABLE  FOR ANY  DIRECT,
20   * INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES
21   * (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT OF  SUBSTITUTE  GOODS OR
22   * SERVICES;  LOSS  OF USE,  DATA,  OR PROFITS;  OR  BUSINESS INTERRUPTION)
23   * HOWEVER CAUSED  AND ON  ANY THEORY  OF LIABILITY,  WHETHER IN  CONTRACT,
24   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25   * ANY  WAY  OUT OF  THE  USE OF  THIS  SOFTWARE, EVEN  IF  ADVISED OF  THE
26   * POSSIBILITY OF SUCH DAMAGE.
27   *
28   * $Id: AbstractProducer.java,v 1.3 2005/08/26 18:09:36 mat007 Exp $
29   */
30  
31  package jtge.engine.handler;
32  
33  import jtge.engine.command.ICommand;
34  
35  /***
36   * Captures producers abstraction.
37   * <p>
38   * The purpose of a producer is to generate commands.
39   *
40   * @author Mathieu Champlon
41   * @version $Revision: 1.3 $ $Date: 2005/08/26 18:09:36 $
42   */
43  public abstract class AbstractProducer
44  {
45      private final IConsumer consumer;
46  
47      /***
48       * Create a producer.
49       *
50       * @param consumer the target consumer
51       */
52      protected AbstractProducer( final IConsumer consumer )
53      {
54          if( consumer == null )
55              throw new IllegalArgumentException( "argument 'consumer' is null." );
56          this.consumer = consumer;
57      }
58  
59      /***
60       * Send a command to the target consumer.
61       *
62       * @param command the command to send
63       */
64      protected final void forward( final ICommand command )
65      {
66          consumer.handle( command );
67      }
68  }