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: ObjectOutput.java,v 1.7 2005/09/10 11:26:47 mat007 Exp $
29   */
30  
31  package jtge.engine.io;
32  
33  import java.io.IOException;
34  import java.io.ObjectOutputStream;
35  import java.io.OutputStream;
36  import jtge.engine.command.ICommand;
37  
38  /***
39   * Implements an output implementation based on object serialization.
40   *
41   * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/serialization/spec/output.html">Object Serialization
42   *      Specification, Section 3, Object AbstractOutput Classes</a>
43   * @author Mathieu Champlon
44   * @version $Revision: 1.7 $ $Date: 2005/09/10 11:26:47 $
45   */
46  public class ObjectOutput implements IOutputImp
47  {
48      private final OutputStream stream;
49      private ObjectOutputStream output;
50      private boolean isClosed;
51  
52      /***
53       * Create an output.
54       *
55       * @param stream the stream to read data from
56       */
57      public ObjectOutput( final OutputStream stream )
58      {
59          if( stream == null )
60              throw new IllegalArgumentException( "argument 'stream' is null" );
61          this.stream = stream;
62          isClosed = false;
63      }
64  
65      /***
66       * {@inheritDoc}
67       */
68      public final void write( final ICommand command )
69      {
70          try
71          {
72              if( output == null )
73                  output = new ObjectOutputStream( stream );
74              if( command != null )
75                  output.writeObject( command );
76          }
77          catch( Exception e )
78          {
79              throw new InputOutputException( e );
80          }
81      }
82  
83      /***
84       * {@inheritDoc}
85       */
86      public final void close()
87      {
88          try
89          {
90              isClosed = true;
91              if( output != null )
92                  output.close();
93              stream.close();
94          }
95          catch( IOException e )
96          {
97              throw new InputOutputException( e );
98          }
99      }
100 
101     /***
102      * {@inheritDoc}
103      */
104     public final boolean isClosed()
105     {
106         return isClosed;
107     }
108 }