java.lang.Object
   |
   +--java.io.InputStream
         |
         +--java.io.ObjectInputStream

Deklaration

Beschreibung

Geschachtelte Klassen
public abstract static	ObjectInputStream.GetField

Konstruktoren
public	ObjectInputStream(InputStream in)
protected	ObjectInputStream()

Methoden
public int	available()
public void	close()
public final void	defaultReadObject()
protected boolean	enableResolveObject(boolean enable)
public int	read()
public int	read(byte[] b, int off, int len)
public boolean	readBoolean()
public byte	readByte()
public char	readChar()
protected ObjectStreamClass	readClassDescriptor()
public double	readDouble()
public GetField	readFields()
public float	readFloat()
public void	readFully(byte[] data)
public void	readFully(byte[] data, int off, int len)
public int	readInt()
public String	readLine()       Verworfen in Version 1.2.
public long	readLong()
public final Object	readObject()
protected void	readObjectOverride(Object obj)
public short	readShort()
protected void	readStreamHeader()
public Object	readUnshared()
public String	readUTF()
public int	readUnsignedByte()
public int	readUnsignedShort()
public synchronized void	registerValidation(ObjectInputValidation obj, int prio)
protected Class	resolveClass(ObjectStreamClass v)
protected Object	resolveObject(Object obj)
protected Class	resolveProxyClass(String[] interfaces)
public int	skipBytes(int n)

Konstruktoren im Detail

public ObjectInputStream(InputStream in)

Erzeugt einen neuen ObjectInputStream auf dem Stream in.

Exception: IOException

• Falls ein Fehler im darunterliegenden Stream aufgetreten ist.

Exception: StreamCorruptedException

• Wenn der Stream nicht mit dem erwarteten Header beginnt.

protected ObjectInputStream()     

Dieser Konstruktor kann von Unterklassen benutzt werden, die eine andere Implementierung zum Einlesen von Objekten realisieren wollen. Dieser Konstruktor setzt die Berechtigung "enableSubclassImplementation" voraus, die mit einer SerializablePermission gesetzt werden kann. Die Neuimplementierung erfolgt durch Überschreiben der Methode readObjectOverride().

Methoden im Detail

public int available()

Liefert die Anzahl an Bytes, die momentan gelesen werden kann, ohne zu blockieren.

Exception: IOException

public void close()

Schließt den Stream.

Exception: IOException

public final void defaultReadObject()

Liest ein Objekt gemäß den Regeln des Serializable-Interfaces aus dem darunterliegenden Stream.

Exception: IOException

• Falls beim Lesen des Objekts ein Fehler aufgetreten ist.

Exception: ClassNotFoundException

• Falls die Klassenbeschreibung nicht gefunden wurde.

Exception: NotActiveException

• Falls der Aufruf nicht aus der readObject()-Methode eines zu rekonstruierenden Objekts erfolgte.

protected boolean enableResolveObject(boolean enable)

Diese Methode gestattet es dem Stream in Abhängigkeit vom Parameter enable, bei der Rekonstruktion ein Objekt durch ein anderes zu ersetzen. Sie setzt die Berechtigung "enableSubstitution" voraus, die mit einer SerializablePermission gesetzt werden kann.

Exception: SecurityException

• Falls die erforderliche Berechtigung nicht besteht.

public int read()

Liest ein Byte aus dem Stream und liefert es zurück. Der Rückgabewert -1 signalisiert, dass das Ende des Streams erreicht wurde. Wenn momentan keine Daten im Stream bereitstehen, blockiert diese Methode so lange, bis wieder mindestens 1 Byte gelesen werden kann oder das Stream-Ende erreicht ist.

Exception: IOException

public int read(byte[] b, int off, int len)

Versucht, len Bytes aus dem Stream zu lesen und speichert sie ab dem Index off in b. Wenn beim Versuch, das erste Byte zu lesen, das Stream-Ende bereits erreicht war, ist der Rückgabewert -1, ansonsten wird die Anzahl der tatsächlich gelesenen Bytes zurückgeliefert. Wenn während des Lesevorgangs das Stream-Ende erreicht wird oder wenn im darunterliegenden Stream nur weniger als len Bytes gelesen werden können, ohne zu blockieren, kehrt die Methode zurück und liefert die Anzahl der bis dahin gelesenen Bytes.

Exception: IOException

public boolean readBoolean()

Liest einen boolean-Wert aus dem Stream.

Exception: IOException

public byte readByte()

Liest einen byte-Wert aus dem Stream.

Exception: IOException

public char readChar()

Liest einen char-Wert aus dem Stream.

Exception: IOException

protected ObjectStreamClass readClassDescriptor()     

Liest einen Klassendeskriptor aus dem Stream und liefert ihn zurück.

Exception: IOException

public double readDouble()

Liest einen double-Wert aus dem Stream.

Exception: IOException

public GetField readFields()     

Liest alle Datenelemente des nächsten Objekts im Stream aus und liefert eine GetField-Objekt zurück, mit dem die Werte dieser Datenelemente abgerufen werden können.

Exception: IOException

Exception: ClassNotFoundException

• Falls die Klassendatei eines persistenten Objekts nicht gefunden werden konnte.

Exception: NotActiveException

public float readFloat()

Liest einen float-Wert aus dem Stream.

Exception: IOException

public void readFully(byte[] data)

Füllt den Puffer data bis zur vollen Länge mit den nächsten Zeichen aus dem Stream. Diese Methode blockiert so lange, bis data.length Bytes gelesen wurden oder vorzeitig das Ende des Streams auftritt.

Exception: IOException

public void readFully(byte[] data, int off, int len)

Liest len Bytes aus dem Stream und speichert sie ab dem Index off im Puffer data. Diese Methode blockiert so lange, bis len Bytes gelesen wurden oder vorzeitig das Ende des Streams auftritt.

Exception: IOException

public int readInt()

Liest einen int-Wert aus dem Stream.

Exception: IOException

public String readLine()

Liest eine Textzeile aus dem Stream. Als Zeilenende-Sequenz wird '\r', '\n' (UNIX) oder "\r\n" (Windows) akzeptiert.

Exception: IOException

public long readLong()

Liest einen long-Wert aus dem Stream.

Exception: IOException

public final Object readObject()

Liest ein serialisiertes Objekt aus dem Stream und liefert es zurück.

Exception: OptionalDataException

• Falls beim Lesen primitive Daten vorgefunden wurden.

Exception: ClassNotFoundException

• Falls die Klassenbeschreibung nicht gefunden wurde.

Exception: IOException

• Falls beim Lesen des Objekts ein Fehler aufgetreten ist.

protected void readObjectOverride(Object obj)     

Mit dieser Methode kann eine Unterklasse ein eigenes Verfahren zum Einlesen von Objekten implementieren. Wenn die Unterklasse in ihrem Konstruktor den parameter-freien Konstruktor dieser Klasse aufruft, wird intern ein Flag gesetzt, durch das die Methode readObject() automatisch diese Methode aufruft und dann zurückkehrt.

Exception: OptionalDataException

• Falls beim Lesen primitive Daten vorgefunden wurden.

Exception: ClassNotFoundException

• Falls die Klassenbeschreibung nicht gefunden wurde.

Exception: IOException

• Falls beim Lesen des Objekts ein Fehler aufgetreten ist.

public short readShort()

Liest einen short-Wert aus dem Stream.

Exception: IOException

protected void readStreamHeader()

Liest den Header des Objekt-Streams aus. Kann überschrieben werden, um ein eigenes Header-Format zu implementieren.

Exception: IOException

• Falls beim Lesen des Headers ein Fehler auftritt.

Exception: StreamCorruptedException

• Wenn der Stream nicht mit dem erwarteten Header beginnt.

public Object readUnshared()     

Diese Methode ist im wesentlichen identisch mit readObject(). Im Gegensatz zu readObject() wird bei dieser Methode sichergestellt, dass nachfolgend mit readObject() geladene Objekte keine Referenzen auf das von dieser Methode gelieferte Objekt enthalten.

public String readUTF()

Liest einen UTF-codierten String aus dem Stream und liefert ihn zurück. Hierbei werden jeweils bis zu 3 Bytes pro Zeichen aus dem Stream gelesen und gemäß der UTF-Codierung in eine Kette von 16-Bit-Unicode-Zeichen transformiert, aus denen der Ergebnis-String aufgebaut wird.

Exception: IOException

public int readUnsignedByte()

Liest ein als vorzeichenlos interpretiertes Byte aus dem Stream und liefert es als int-Wert zurück.

Exception: IOException

public int readUnsignedShort()

Liest zwei als vorzeichenlos interpretierte Bytes aus dem Stream und liefert sie als int-Wert zurück.

Exception: IOException

public synchronized void registerValidation(ObjectInputValidation obj, int prio)

Mit dieser Methode kann innerhalb der readObject()-Methode einer Klasse ein ObjectInputValidation-Objekt registriert werden. Dieses Objekt erhält einen Callback, nachdem der vollständige Objekt-Graph rekonstruiert wurde. Der Callback erfolgt, bevor der Objekt-Graph an der Aufrufer übergeben wird. Die Reihenfolge der Callbacks ergibt sich aus der Priorität prio, mit der obj in die interne Prioritätswarteschlange eingereiht wird.

Exception: NotActiveException

• Falls der Aufruf nicht aus der readObject()-Methode eines zu rekonstruierenden Objekts erfolgte.

Exception: InvalidObjectException

• Falls für obj den Wert null hat.

protected Class resolveClass(ObjectStreamClass v)

Diese Methode wird für jede Klasse bei ihrem ersten Auftreten bei der Rekonstruktion eines Objekt-Graphen aufgerufen und erlaubt es, eine Klasse durch eine andere zu ersetzen. Für die neue Klasse muß ein Class-Objekt zurückgegeben werden. Das Gegenstück zu dieser Methode ist ObjectOutputStream.annotateClass().

Exception: IOException

• Falls beim Lesen des Objekts ein Fehler aufgetreten ist.

Exception: ClassNotFoundException

• Falls die Klassenbeschreibung nicht gefunden wurde.

protected Object resolveObject(Object obj)

Diese Methode wird für jedes rekonstruierte Objekt aufgerufen und erlaubt es, ein Objekt durch ein anderes zu ersetzen. Standardmäßig reicht diese Methode das übergebene Objekt durch.

Exception: IOException

protected Class resolveProxyClass(String[] interfaces)     

Liest eine Proxy-Klasse für die in interfaces bezeichneten Interfaces aus dem Stream und liefert sie zurück. Diese Methode kann in Unterklassen überschrieben werden, um zusätzliche Informationen für Proxy-Klassen aus dem Stream zu lesen.

Exception: IOException

Exception: ClassNotFoundException

public int skipBytes(int n)

Versucht, n Bytes aus dem Stream zu überlesen, und liefert die Anzahl der tatsächlich übersrungenen Bytes. Diese kann kleiner als n sein, wenn vorzeitig das Ende des Streams erreicht wird. Fall momentan weniger als n Bytes im Stream bereitstehen, blockiert diese Methode so lange, bis n Bytes gelesen werden konnten oder das Stream-Ende erreicht ist.

Exception: IOException