1 /* 2 * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.io; 27 28 /** 29 * ObjectOutput extends the DataOutput interface to include writing of objects. 30 * DataOutput includes methods for output of primitive types, ObjectOutput 31 * extends that interface to include objects, arrays, and Strings. 32 * 33 * @author unascribed 34 * @see java.io.InputStream 35 * @see java.io.ObjectOutputStream 36 * @see java.io.ObjectInputStream 37 * @since JDK1.1 38 */ 39 public interface ObjectOutput extends DataOutput, AutoCloseable { 40 /** 41 * Write an object to the underlying storage or stream. The 42 * class that implements this interface defines how the object is 43 * written. 44 * 45 * @param obj the object to be written 46 * @exception IOException Any of the usual Input/Output related exceptions. 47 */ writeObject(Object obj)48 public void writeObject(Object obj) 49 throws IOException; 50 51 /** 52 * Writes a byte. This method will block until the byte is actually 53 * written. 54 * @param b the byte 55 * @exception IOException If an I/O error has occurred. 56 */ write(int b)57 public void write(int b) throws IOException; 58 59 /** 60 * Writes an array of bytes. This method will block until the bytes 61 * are actually written. 62 * @param b the data to be written 63 * @exception IOException If an I/O error has occurred. 64 */ write(byte b[])65 public void write(byte b[]) throws IOException; 66 67 /** 68 * Writes a sub array of bytes. 69 * @param b the data to be written 70 * @param off the start offset in the data 71 * @param len the number of bytes that are written 72 * @exception IOException If an I/O error has occurred. 73 */ write(byte b[], int off, int len)74 public void write(byte b[], int off, int len) throws IOException; 75 76 /** 77 * Flushes the stream. This will write any buffered 78 * output bytes. 79 * @exception IOException If an I/O error has occurred. 80 */ flush()81 public void flush() throws IOException; 82 83 /** 84 * Closes the stream. This method must be called 85 * to release any resources associated with the 86 * stream. 87 * @exception IOException If an I/O error has occurred. 88 */ close()89 public void close() throws IOException; 90 } 91