GrepCode: java.io.ObjectInput (.java) - Interface

JDK
/
jdk / openjdk
/
6-b14

7-b147
6-b14
/
java.io.ObjectInput
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Copyright 1996-1999 Sun Microsystems, Inc.  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.  Sun designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22
  * CA 95054 USA or visit www.sun.com if you need additional information or
23
  * have any questions.
24
  */
25
 
26
 package java.io;

 ObjectInput extends the DataInput interface to include the reading of
 objects. DataInput includes methods for the input of primitive types,
 ObjectInput extends that interface to include objects, arrays, and Strings.

 
 Author(s):unascribed Since:JDK1.1 See also:InputStreamObjectOutputStreamObjectInputStream
38
 
39
 public interface ObjectInput extends DataInput {
    
 Read and return an object. The class that implements this interface
 defines where the object is "read" from.

 
 Returns:the object read from the stream Throws:java.lang.ClassNotFoundException If the class of a serialized
      object cannot be found.IOException If any of the usual Input/Output
 related exceptions occur.
49
 
50
     public Object readObject()
51
         throws ClassNotFoundException, IOException;

    
 Reads a byte of data. This method will block if no input is
 available.
 
 Returns:the byte read, or -1 if the end of the
          stream is reached. Throws:IOException If an I/O error has occurred.
59
 
60
     public int read() throws IOException;

    
 Reads into an array of bytes.  This method will
 block until some input is available.
 
 Parameters:b the buffer into which the data is read Returns:the actual number of bytes read, -1 is
          returned when the end of the stream is reached. Throws:IOException If an I/O error has occurred.
69
 
70
     public int read(byte b[]) throws IOException;

    
 Reads into an array of bytes.  This method will
 block until some input is available.
 
 Parameters:b the buffer into which the data is readoff the start offset of the datalen the maximum number of bytes read Returns:the actual number of bytes read, -1 is
          returned when the end of the stream is reached. Throws:IOException If an I/O error has occurred.
81
 
82
     public int read(byte b[], int off, int len) throws IOException;

    
 Skips n bytes of input.
 
 Parameters:n the number of bytes to be skipped Returns:the actual number of bytes skipped. Throws:IOException If an I/O error has occurred.
89
 
90
     public long skip(long n) throws IOException;

    
 Returns the number of bytes that can be read
 without blocking.
 
 Returns:the number of available bytes. Throws:IOException If an I/O error has occurred.
97
 
98
     public int available() throws IOException;

    
 Closes the input stream. Must be called
 to release any resources associated with
 the stream.
 
 Throws:IOException If an I/O error has occurred.
105
106
    public void close() throws IOException;
107
}