org.concord.util.beans
Class XMLDecoder

java.lang.Object
  |
  +--org.concord.util.beans.XMLDecoder

public class XMLDecoder

extends java.lang.Object

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();
 

Since:

1.4

Version:

1.5 11/20/00

Author:

Philip Milne

See Also:

XMLEncoder, ObjectInputStream

Constructor Summary

XMLDecoder(java.io.InputStream in)
Creates a new input stream for reading archives created by the XMLEncoder class.

XMLDecoder(java.io.InputStream in, java.lang.Object owner)
Creates a new input stream for reading archives created by the XMLEncoder class.

XMLDecoder(java.io.InputStream in, java.lang.Object owner, ExceptionListener exceptionListener)
Creates a new input stream for reading archives created by the XMLEncoder class.

Method Summary

void	close() This method closes the input stream associated with this stream.
ExceptionListener	getExceptionListener() Gets the exception handler for this stream.
java.lang.Object	getOwner() Gets the owner of this decoder.
java.lang.Object	readObject() Reads the next object from the input.
void	setExceptionListener(ExceptionListener exceptionListener) Sets the exception handler for this stream to exceptionListener.
void	setOwner(java.lang.Object owner) Sets the owner of this decoder to owner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLDecoder

public XMLDecoder(java.io.InputStream in)

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

Parameters:

in - The underlying stream.

See Also:

XMLEncoder.XMLEncoder(OutputStream)

XMLDecoder

public XMLDecoder(java.io.InputStream in,
                  java.lang.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.

XMLDecoder

public XMLDecoder(java.io.InputStream in,
                  java.lang.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.

Method Detail

close

public void close()

This method closes the input stream associated with this stream.

setExceptionListener

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.

See Also:

getExceptionListener()

getExceptionListener

public ExceptionListener getExceptionListener()

Gets the exception handler for this stream.

Returns:

The exception handler for this stream.

See Also:

setExceptionListener(org.concord.util.beans.ExceptionListener)

readObject

public java.lang.Object readObject()

Reads the next object from the input.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the stream contains no objects (or no more objects)

See Also:

XMLEncoder.writeObject(java.lang.Object)

setOwner

public void setOwner(java.lang.Object owner)

Sets the owner of this decoder to owner.

Parameters:

owner - The owner of this decoder.

See Also:

getOwner()

getOwner

public java.lang.Object getOwner()

Gets the owner of this decoder.

Returns:

The owner of this decoder.

See Also:

setOwner(java.lang.Object)