- java.lang.Object
-
- java.beans.XMLDecoder
-
- All Implemented Interfaces:
AutoCloseable
public class XMLDecoder extends Object implements AutoCloseable
TheXMLDecoderclass is used to read XML documents created using theXMLEncoderand is used just like theObjectInputStream. For example, one can use the following fragment to read the first object defined in an XML document written by theXMLEncoderclass: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:
XMLEncoder,ObjectInputStream
-
-
Constructor Summary
Constructors Constructor Description XMLDecoder(InputStream in)Creates a new input stream for reading archives created by theXMLEncoderclass.XMLDecoder(InputStream in, Object owner)Creates a new input stream for reading archives created by theXMLEncoderclass.XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener)Creates a new input stream for reading archives created by theXMLEncoderclass.XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener, ClassLoader cl)Creates a new input stream for reading archives created by theXMLEncoderclass.XMLDecoder(InputSource is)Creates a new decoder to parse XML archives created by theXMLEncoderclass.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()This method closes the input stream associated with this stream.static DefaultHandlercreateHandler(Object owner, ExceptionListener el, ClassLoader cl)Creates a new handler for SAX parser that can be used to parse embedded XML archives created by theXMLEncoderclass.ExceptionListenergetExceptionListener()Gets the exception handler for this stream.ObjectgetOwner()Gets the owner of this decoder.ObjectreadObject()Reads the next object from the underlying input stream.voidsetExceptionListener(ExceptionListener exceptionListener)Sets the exception handler for this stream toexceptionListener.voidsetOwner(Object owner)Sets the owner of this decoder toowner.
-
-
-
Constructor Detail
-
XMLDecoder
public XMLDecoder(InputStream in)
Creates a new input stream for reading archives created by theXMLEncoderclass.- Parameters:
in- The underlying stream.- See Also:
XMLEncoder(java.io.OutputStream)
-
XMLDecoder
public XMLDecoder(InputStream in, Object owner)
Creates a new input stream for reading archives created by theXMLEncoderclass.- Parameters:
in- The underlying stream.owner- The owner of this stream.
-
XMLDecoder
public XMLDecoder(InputStream in, Object owner, ExceptionListener exceptionListener)
Creates a new input stream for reading archives created by theXMLEncoderclass.- Parameters:
in- the underlying stream.owner- the owner of this stream.exceptionListener- the exception handler for the stream; ifnullthe 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 theXMLEncoderclass.- Parameters:
in- the underlying stream.nullmay be passed without error, though the resulting XMLDecoder will be uselessowner- the owner of this stream.nullis a legal valueexceptionListener- the exception handler for the stream, ornullto use the defaultcl- the class loader used for instantiating objects.nullindicates that the default class loader should be used- Since:
- 1.5
-
XMLDecoder
public XMLDecoder(InputSource is)
Creates a new decoder to parse XML archives created by theXMLEncoderclass. If the input sourceisisnull, no exception is thrown and no parsing is performed. This behavior is similar to behavior of other constructors that useInputStreamas a parameter.- Parameters:
is- the input source to parse- Since:
- 1.7
-
-
Method Detail
-
close
public void close()
This method closes the input stream associated with this stream.- Specified by:
closein interfaceAutoCloseable
-
setExceptionListener
public void setExceptionListener(ExceptionListener exceptionListener)
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; ifnullthe default exception listener will be used.- See Also:
getExceptionListener()
-
getExceptionListener
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:
setExceptionListener(java.beans.ExceptionListener)
-
readObject
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:
XMLEncoder.writeObject(java.lang.Object)
-
setOwner
public void setOwner(Object owner)
Sets the owner of this decoder toowner.- Parameters:
owner- The owner of this decoder.- See Also:
getOwner()
-
getOwner
public Object getOwner()
Gets the owner of this decoder.- Returns:
- The owner of this decoder.
- See Also:
setOwner(java.lang.Object)
-
createHandler
public 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 theXMLEncoderclass. Theownershould be used if parsed XML document contains the method call within context of the <java> element. Thenullvalue may cause illegal parsing in such case. The same problem may occur, if theownerclass 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, ornullto use the default exception handlercl- the class loader used for instantiating objects, ornullto use the default class loader- Returns:
- an instance of
DefaultHandlerfor SAX parser - Since:
- 1.7
-
-