| 1 | /* ObjectOutput.java -- Interface for writing objects to a stream
|
|---|
| 2 | Copyright (C) 1998 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 <code>OutputStream</code> like.
|
|---|
| 45 | *
|
|---|
| 46 | * @version 0.0
|
|---|
| 47 | *
|
|---|
| 48 | * @author Aaron M. Renn (arenn@urbanophile.com)
|
|---|
| 49 | */
|
|---|
| 50 | public interface ObjectOutput extends DataOutput
|
|---|
| 51 | {
|
|---|
| 52 |
|
|---|
| 53 |
|
|---|
| 54 | /**
|
|---|
| 55 | * This method writes the specified byte to the output stream.
|
|---|
| 56 | *
|
|---|
| 57 | * @param b The byte to write.
|
|---|
| 58 | *
|
|---|
| 59 | * @exception IOException If an error occurs.
|
|---|
| 60 | */
|
|---|
| 61 | public abstract void
|
|---|
| 62 | write(int b) throws IOException;
|
|---|
| 63 |
|
|---|
| 64 | /*************************************************************************/
|
|---|
| 65 |
|
|---|
| 66 | /**
|
|---|
| 67 | * This method writes all the bytes in the specified byte array to the
|
|---|
| 68 | * output stream.
|
|---|
| 69 | *
|
|---|
| 70 | * @param buf The array of bytes to write.
|
|---|
| 71 | *
|
|---|
| 72 | * @exception IOException If an error occurs.
|
|---|
| 73 | */
|
|---|
| 74 | public abstract void
|
|---|
| 75 | write(byte[] buf) throws IOException;
|
|---|
| 76 |
|
|---|
| 77 | /*************************************************************************/
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * This method writes <code>len</code> bytes from the specified array
|
|---|
| 81 | * starting at index <code>offset</code> into that array.
|
|---|
| 82 | *
|
|---|
| 83 | * @param buf The byte array to write from.
|
|---|
| 84 | * @param offset The index into the byte array to start writing from.
|
|---|
| 85 | * @param len The number of bytes to write.
|
|---|
| 86 | *
|
|---|
| 87 | * @exception IOException If an error occurs.
|
|---|
| 88 | */
|
|---|
| 89 | public abstract void
|
|---|
| 90 | write(byte[] buf, int offset, int len) throws IOException;
|
|---|
| 91 |
|
|---|
| 92 | /*************************************************************************/
|
|---|
| 93 |
|
|---|
| 94 | /**
|
|---|
| 95 | * This method writes a object instance to a stream. The format of the
|
|---|
| 96 | * data written is determined by the actual implementation of this method
|
|---|
| 97 | *
|
|---|
| 98 | * @param obj The object to write
|
|---|
| 99 | *
|
|---|
| 100 | * @exception IOException If an error occurs
|
|---|
| 101 | */
|
|---|
| 102 | public abstract void
|
|---|
| 103 | writeObject(Object obj) throws IOException;
|
|---|
| 104 |
|
|---|
| 105 | /*************************************************************************/
|
|---|
| 106 |
|
|---|
| 107 | /**
|
|---|
| 108 | * This method causes any buffered data to be flushed out to the underlying
|
|---|
| 109 | * stream
|
|---|
| 110 | *
|
|---|
| 111 | * @exception IOException If an error occurs
|
|---|
| 112 | */
|
|---|
| 113 | public abstract void
|
|---|
| 114 | flush() throws IOException;
|
|---|
| 115 |
|
|---|
| 116 | /*************************************************************************/
|
|---|
| 117 |
|
|---|
| 118 | /**
|
|---|
| 119 | * This method closes the underlying stream.
|
|---|
| 120 | *
|
|---|
| 121 | * @exception IOException If an error occurs
|
|---|
| 122 | */
|
|---|
| 123 | public abstract void
|
|---|
| 124 | close() throws IOException;
|
|---|
| 125 |
|
|---|
| 126 | } // interface ObjectOutput
|
|---|
| 127 |
|
|---|
