Java Doc for SaxWriter.java in  » XML » xstream-1.3 » com » thoughtworks » xstream » io » xml » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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

Configuration of this SAX parser is achieved through the standard SaxWriter.setProperty 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 SaxWriter.SOURCE_OBJECT_LIST_PROPERTY objects to be serialized as well as the SaxWriter.CONFIGURED_XSTREAM_PROPERTY XStream facade .

The feature name is any fully-qualified URI.

The property name is any fully-qualified URI.

This method is a shortcut for the common case of reading a document from a system identifier.

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).

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.

The property name is any fully-qualified URI.

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.

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.

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 SaxWriter.SOURCE_OBJECT_LIST_PROPERTY ) to define the list of objects to serialize.

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 SaxWriter.SOURCE_OBJECT_LIST_PROPERTY ) to define the list of objects to serialize.

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.

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.

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.

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.

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.

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: SaxWriter.CONFIGURED_XSTREAM_PROPERTY and SaxWriter.SOURCE_OBJECT_LIST_PROPERTY .