public final class

SaxWriter

extends AbstractXmlWriter
implements XMLReader
java.lang.Object
   ↳ com.thoughtworks.xstream.io.xml.AbstractXmlWriter
     ↳ com.thoughtworks.xstream.io.xml.SaxWriter

Class Overview

A SAX org.xml.sax.XMLReader parser that acts as an XStream HierarchicalStreamWriter to enable direct generation of a SAX event flow from the XStream serialization of a list of list of Java objects.

As a custom SAX parser, this class ignores the arguments of the two standard parse methods (parse(java.lang.String) and parse(org.xml.sax.InputSource)) but relies on a proprietary SAX property SOURCE_OBJECT_LIST_PROPERTY to define the list of objects to serialize.

Configuration of this SAX parser is achieved through the standard SAX property mechanism. While specific setter methods require direct access to the parser instance, SAX properties support configuration settings to be propagated through a chain of org.xml.sax.XMLFilter filters down to the underlying parser object.

This mechanism shall be used to configure the objects to be serialized as well as the XStream facade.

Summary

Constants
String CONFIGURED_XSTREAM_PROPERTY The SAX property to configure the XStream facade to be used for object serialization.
String SOURCE_OBJECT_LIST_PROPERTY The SAX property to configure the list of Java objects to serialize.
Public Constructors
SaxWriter(XmlFriendlyReplacer replacer)
SaxWriter(boolean includeEnclosingDocument, XmlFriendlyReplacer replacer)
SaxWriter(boolean includeEnclosingDocument)
SaxWriter()
Public Methods
void addAttribute(String name, String value)
void close()
void endNode()
void flush()
ContentHandler getContentHandler()
Returns the current content handler.
DTDHandler getDTDHandler()
Returns the current DTD handler.
EntityResolver getEntityResolver()
Returns the current entity resolver.
ErrorHandler getErrorHandler()
Returns the current error handler.
boolean getFeature(String name)
Looks up the value of a feature.
Object getProperty(String name)
Looks up the value of a property.
void parse(InputSource input)
Parse an XML document.
void parse(String systemId)
Parses an XML document from a system identifier (URI).
void setContentHandler(ContentHandler handler)
Allows an application to register a content event handler.
void setDTDHandler(DTDHandler handler)
Allows an application to register a DTD event handler.
void setEntityResolver(EntityResolver resolver)
Allows an application to register an entity resolver.
void setErrorHandler(ErrorHandler handler)
Allows an application to register an error event handler.
void setFeature(String name, boolean value)
Sets the state of a feature.
void setProperty(String name, Object value)
Sets the value of a property.
void setValue(String text)
void startNode(String name)
[Expand]
Inherited Methods
From class com.thoughtworks.xstream.io.xml.AbstractXmlWriter
From class java.lang.Object
From interface com.thoughtworks.xstream.io.ExtendedHierarchicalStreamWriter
From interface com.thoughtworks.xstream.io.HierarchicalStreamWriter
From interface com.thoughtworks.xstream.io.xml.XmlFriendlyWriter
From interface org.xml.sax.XMLReader

Constants

public static final String CONFIGURED_XSTREAM_PROPERTY

The SAX property to configure the XStream facade to be used for object serialization. If the property is not set, a new XStream facade will be allocated for each parse.

Constant Value: "http://com.thoughtworks.xstream/sax/property/configured-xstream"

public static final String SOURCE_OBJECT_LIST_PROPERTY

The SAX property to configure the list of Java objects to serialize. Setting this property prior invoking one of the parse() methods is mandatory.

See Also
Constant Value: "http://com.thoughtworks.xstream/sax/property/source-object-list"

Public Constructors

public SaxWriter (XmlFriendlyReplacer replacer)

public SaxWriter (boolean includeEnclosingDocument, XmlFriendlyReplacer replacer)

public SaxWriter (boolean includeEnclosingDocument)

public SaxWriter ()

Public Methods

public void addAttribute (String name, String value)

public void close ()

public void endNode ()

public void flush ()

public ContentHandler getContentHandler ()

Returns the current content handler.

Returns
  • the current content handler, or null if none has been registered.
See Also

public DTDHandler getDTDHandler ()

Returns the current DTD handler.

Returns
  • the current DTD handler, or null if none has been registered.
See Also

public EntityResolver getEntityResolver ()

Returns the current entity resolver.

Returns
  • the current entity resolver, or null if none has been registered.
See Also

public ErrorHandler getErrorHandler ()

Returns the current error handler.

Returns
  • the current error handler, or null if none has been registered.
See Also

public boolean getFeature (String name)

Looks up the value of a feature.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.

All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.

Some feature values may be available only in specific contexts, such as before, during, or after a parse.

Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

Parameters
name the feature name, which is a fully-qualified URI.
Returns
  • the current state of the feature (true or false).
Throws
SAXNotRecognizedException when the XMLReader does not recognize the feature name.
See Also

public Object getProperty (String name)

Looks up the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to return its state.

XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

Some property values may be available only in specific contexts, such as before, during, or after a parse.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

Parameters
name the property name, which is a fully-qualified URI.
Returns
  • the current value of the property.
Throws
SAXNotRecognizedException when the XMLReader does not recognize the property name.
See Also

public void parse (InputSource input)

Parse an XML document.

The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source.

During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

Note: As a custom SAX parser, this class ignores the source argument of this method and relies on the proprietary SAX property SOURCE_OBJECT_LIST_PROPERTY) to define the list of objects to serialize.

Parameters
input The input source for the top-level of the XML document.
Throws
SAXException Any SAX exception, possibly wrapping another exception.
See Also

public void parse (String systemId)

Parses an XML document from a system identifier (URI).

This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

    parse(new InputSource(systemId));

If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

Note: As a custom SAX parser, this class ignores the systemId argument of this method and relies on the proprietary SAX property SOURCE_OBJECT_LIST_PROPERTY) to define the list of objects to serialize.

Parameters
systemId the system identifier (URI).
Throws
SAXException Any SAX exception, possibly wrapping another exception.
See Also

public void setContentHandler (ContentHandler handler)

Allows an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler the content handler.
Throws
NullPointerException if the handler argument is null.
See Also

public void setDTDHandler (DTDHandler handler)

Allows an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler the DTD handler.
Throws
NullPointerException if the handler argument is null.
See Also

public void setEntityResolver (EntityResolver resolver)

Allows an application to register an entity resolver.

If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

Parameters
resolver the entity resolver.
Throws
NullPointerException if the resolver argument is null.
See Also

public void setErrorHandler (ErrorHandler handler)

Allows an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler the error handler.
Throws
NullPointerException if the handler argument is null.
See Also

public void setFeature (String name, boolean value)

Sets the state of a feature.

The feature name is any fully-qualified URI.

All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.

Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

Note: This implementation only supports the two mandatory SAX features.

Parameters
name the feature name, which is a fully-qualified URI.
value the requested state of the feature (true or false).
Throws
SAXNotRecognizedException when the XMLReader does not recognize the feature name.
See Also

public void setProperty (String name, Object value)

Sets the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to set its value.

XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.

Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

This method is also the standard mechanism for setting extended handlers.

Note: This implementation only supports two (proprietary) properties: CONFIGURED_XSTREAM_PROPERTY and SOURCE_OBJECT_LIST_PROPERTY.

Parameters
name the property name, which is a fully-qualified URI.
value the requested value for the property.
Throws
SAXNotRecognizedException when the XMLReader does not recognize the property name.
SAXNotSupportedException when the XMLReader recognizes the property name but cannot set the requested value.
See Also

public void setValue (String text)

public void startNode (String name)