Moving modules around so the runtime is under one master pom and can be built without building other modules that are in the repository
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.
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.
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).
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.
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
29 * ObjectInput extends the DataInput interface to include the reading of
30 * objects. DataInput includes methods for the input of primitive types,
31 * ObjectInput extends that interface to include objects, arrays, and Strings.
34 * @see java.io.InputStream
35 * @see java.io.ObjectOutputStream
36 * @see java.io.ObjectInputStream
39 public interface ObjectInput extends DataInput, AutoCloseable {
41 * Read and return an object. The class that implements this interface
42 * defines where the object is "read" from.
44 * @return the object read from the stream
45 * @exception java.lang.ClassNotFoundException If the class of a serialized
46 * object cannot be found.
47 * @exception IOException If any of the usual Input/Output
48 * related exceptions occur.
50 public Object readObject()
51 throws ClassNotFoundException, IOException;
54 * Reads a byte of data. This method will block if no input is
56 * @return the byte read, or -1 if the end of the
58 * @exception IOException If an I/O error has occurred.
60 public int read() throws IOException;
63 * Reads into an array of bytes. This method will
64 * block until some input is available.
65 * @param b the buffer into which the data is read
66 * @return the actual number of bytes read, -1 is
67 * returned when the end of the stream is reached.
68 * @exception IOException If an I/O error has occurred.
70 public int read(byte b[]) throws IOException;
73 * Reads into an array of bytes. This method will
74 * block until some input is available.
75 * @param b the buffer into which the data is read
76 * @param off the start offset of the data
77 * @param len the maximum number of bytes read
78 * @return the actual number of bytes read, -1 is
79 * returned when the end of the stream is reached.
80 * @exception IOException If an I/O error has occurred.
82 public int read(byte b[], int off, int len) throws IOException;
85 * Skips n bytes of input.
86 * @param n the number of bytes to be skipped
87 * @return the actual number of bytes skipped.
88 * @exception IOException If an I/O error has occurred.
90 public long skip(long n) throws IOException;
93 * Returns the number of bytes that can be read
95 * @return the number of available bytes.
96 * @exception IOException If an I/O error has occurred.
98 public int available() throws IOException;
101 * Closes the input stream. Must be called
102 * to release any resources associated with
104 * @exception IOException If an I/O error has occurred.
106 public void close() throws IOException;