public class

XMLDecoder

extends Object
java.lang.Object
   ↳ java.beans.XMLDecoder

Class Overview

The XMLDecoder class is used to read XML documents created using the XMLEncoder and is used just like the ObjectInputStream. For example, one can use the following fragment to read the first object defined in an XML document written by the XMLEncoder class: 

       XMLDecoder d = new XMLDecoder(
                          new BufferedInputStream(
                              new FileInputStream("Test.xml")));
       Object result = d.readObject();
       d.close();

For more information you might also want to check out Long Term Persistence of JavaBeans Components: XML Schema, an article in The Swing Connection.

See Also

Summary

Public Constructors
XMLDecoder(InputStream in)
Creates a new input stream for reading archives created by the XMLEncoder class.
XMLDecoder(InputStream in, Object owner)
Creates a new input stream for reading archives created by the XMLEncoder class.
XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener)
Creates a new input stream for reading archives created by the XMLEncoder class.
XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener, ClassLoader cl)
Creates a new input stream for reading archives created by the XMLEncoder class.
Public Methods
void close()
This method closes the input stream associated with this stream.
ExceptionListener getExceptionListener()
Gets the exception handler for this stream.
Object getOwner()
Gets the owner of this decoder.
Object readObject()
Reads the next object from the underlying input stream.
void setExceptionListener(ExceptionListener exceptionListener)
Sets the exception handler for this stream to exceptionListener.
void setOwner(Object owner)
Sets the owner of this decoder to owner.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public XMLDecoder (InputStream in)

Creates a new input stream for reading archives created by the XMLEncoder class.

Parameters
in The underlying stream.
See Also

public XMLDecoder (InputStream in, Object owner)

Creates a new input stream for reading archives created by the XMLEncoder class.

Parameters
in The underlying stream.
owner The owner of this stream.

public XMLDecoder (InputStream in, Object owner, ExceptionListener exceptionListener)

Creates a new input stream for reading archives created by the XMLEncoder class.

Parameters
in the underlying stream.
owner the owner of this stream.
exceptionListener the exception handler for the stream; if null the default exception listener will be used.

public XMLDecoder (InputStream in, Object owner, ExceptionListener exceptionListener, ClassLoader cl)

Creates a new input stream for reading archives created by the XMLEncoder class.

Parameters
in the underlying stream. null may be passed without error, though the resulting XMLDecoder will be useless
owner the owner of this stream. null is a legal value
exceptionListener the exception handler for the stream, or null to use the default
cl the class loader used for instantiating objects. null indicates that the default class loader should be used

Public Methods

public void close ()

This method closes the input stream associated with this stream.

public ExceptionListener getExceptionListener ()

Gets the exception handler for this stream.

Returns
  • The exception handler for this stream. Will return the default exception listener if this has not explicitly been set.
See Also

public Object getOwner ()

Gets the owner of this decoder.

Returns
  • The owner of this decoder.
See Also

public Object readObject ()

Reads the next object from the underlying input stream.

Returns
  • the next object read
Throws
ArrayIndexOutOfBoundsException if the stream contains no objects (or no more objects)
See Also

public void setExceptionListener (ExceptionListener exceptionListener)

Sets the exception handler for this stream to exceptionListener. The exception handler is notified when this stream catches recoverable exceptions.

Parameters
exceptionListener The exception handler for this stream; if null the default exception listener will be used.
See Also

public void setOwner (Object owner)

Sets the owner of this decoder to owner.

Parameters
owner The owner of this decoder.
See Also