java.lang.Object
java.beans.XMLDecoder
- All Implemented Interfaces:
AutoCloseable
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.
- Since:
- 1.4
- See Also:
-
Constructor Summary
ConstructorDescriptionCreates a new input stream for reading archives created by theXMLEncoder
class.XMLDecoder
(InputStream in, Object owner) Creates a new input stream for reading archives created by theXMLEncoder
class.XMLDecoder
(InputStream in, Object owner, ExceptionListener exceptionListener) Creates a new input stream for reading archives created by theXMLEncoder
class.XMLDecoder
(InputStream in, Object owner, ExceptionListener exceptionListener, ClassLoader cl) Creates a new input stream for reading archives created by theXMLEncoder
class.Creates a new decoder to parse XML archives created by theXMLEncoder
class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This method closes the input stream associated with this stream.static DefaultHandler
createHandler
(Object owner, ExceptionListener el, ClassLoader cl) Creates a new handler for SAX parser that can be used to parse embedded XML archives created by theXMLEncoder
class.Gets the exception handler for this stream.getOwner()
Gets the owner of this decoder.Reads the next object from the underlying input stream.void
setExceptionListener
(ExceptionListener exceptionListener) Sets the exception handler for this stream toexceptionListener
.void
Sets the owner of this decoder toowner
.
-
Constructor Details
-
XMLDecoder
Creates a new input stream for reading archives created by theXMLEncoder
class.- Parameters:
in
- The underlying stream.- See Also:
-
XMLDecoder
Creates a new input stream for reading archives created by theXMLEncoder
class.- Parameters:
in
- The underlying stream.owner
- The owner of this stream.
-
XMLDecoder
Creates a new input stream for reading archives created by theXMLEncoder
class.- Parameters:
in
- the underlying stream.owner
- the owner of this stream.exceptionListener
- the exception handler for the stream; ifnull
the default exception listener will be used.
-
XMLDecoder
public XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener, ClassLoader cl) Creates a new input stream for reading archives created by theXMLEncoder
class.- Parameters:
in
- the underlying stream.null
may be passed without error, though the resulting XMLDecoder will be uselessowner
- the owner of this stream.null
is a legal valueexceptionListener
- the exception handler for the stream, ornull
to use the defaultcl
- the class loader used for instantiating objects.null
indicates that the default class loader should be used- Since:
- 1.5
-
XMLDecoder
Creates a new decoder to parse XML archives created by theXMLEncoder
class. If the input sourceis
isnull
, no exception is thrown and no parsing is performed. This behavior is similar to behavior of other constructors that useInputStream
as a parameter.- Parameters:
is
- the input source to parse- Since:
- 1.7
-
-
Method Details
-
close
public void close()This method closes the input stream associated with this stream.- Specified by:
close
in interfaceAutoCloseable
-
setExceptionListener
Sets the exception handler for this stream toexceptionListener
. The exception handler is notified when this stream catches recoverable exceptions.- Parameters:
exceptionListener
- The exception handler for this stream; ifnull
the default exception listener will be used.- See Also:
-
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:
-
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:
-
setOwner
Sets the owner of this decoder toowner
.- Parameters:
owner
- The owner of this decoder.- See Also:
-
getOwner
Gets the owner of this decoder.- Returns:
- The owner of this decoder.
- See Also:
-
createHandler
Creates a new handler for SAX parser that can be used to parse embedded XML archives created by theXMLEncoder
class. Theowner
should be used if parsed XML document contains the method call within context of the <java> element. Thenull
value may cause illegal parsing in such case. The same problem may occur, if theowner
class does not contain expected method to call. See details here.- Parameters:
owner
- the owner of the default handler that can be used as a value of <java> elementel
- the exception handler for the parser, ornull
to use the default exception handlercl
- the class loader used for instantiating objects, ornull
to use the default class loader- Returns:
- an instance of
DefaultHandler
for SAX parser - Since:
- 1.7
-