libjava/java/io/ObjectOutput.java

   1 /* ObjectOutput.java -- Interface for writing objects to a stream
   2    Copyright (C) 1998, 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath 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 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /**
  42   * This interface extends <code>DataOutput</code> to provide the additional
  43   * facility of writing object instances to a stream.  It also adds some
  44   * additional methods to make the interface more
  45   * <code>OutputStream</code> like.
  46   *
  47   * @author Aaron M. Renn (arenn@urbanophile.com)
  48   *
  49   * @see DataOutput
  50   */
  51 public interface ObjectOutput extends DataOutput
  52 {
  53   /**
  54     * This method writes the specified byte to the output stream.
  55     *
  56     * @param b The byte to write.
  57     *
  58     * @exception IOException If an error occurs.
  59     */
  60   void write(int b) throws IOException;
  61
  62   /**
  63     * This method writes all the bytes in the specified byte array to the
  64     * output stream.
  65     *
  66     * @param buf The array of bytes to write.
  67     *
  68     * @exception IOException If an error occurs.
  69     */
  70   void write(byte[] buf) throws IOException;
  71
  72   /**
  73     * This method writes <code>len</code> bytes from the specified array
  74     * starting at index <code>offset</code> into that array.
  75     *
  76     * @param buf The byte array to write from.
  77     * @param offset The index into the byte array to start writing from.
  78     * @param len The number of bytes to write.
  79     *
  80     * @exception IOException If an error occurs.
  81     */
  82   void write(byte[] buf, int offset, int len)
  83     throws IOException;
  84
  85   /**
  86     * This method writes a object instance to a stream.  The format of the
  87     * data written is determined by the actual implementation of this method
  88     *
  89     * @param obj The object to write
  90     *
  91     * @exception IOException If an error occurs
  92     */
  93   void writeObject(Object obj) throws IOException;
  94
  95   /**
  96     * This method causes any buffered data to be flushed out to the underlying
  97     * stream
  98     *
  99     * @exception IOException If an error occurs
 100     */
 101   void flush() throws IOException;
 102
 103   /**
 104     * This method closes the underlying stream.
 105     *
 106     * @exception IOException If an error occurs
 107     */
 108   void close() throws IOException;
 109
 110 } // interface ObjectOutput
 111