|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.thoughtworks.xstream.io.xml.AbstractXmlWriter
com.thoughtworks.xstream.io.xml.SaxWriter
public final class SaxWriter
A SAX 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.
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 mecanism
. While specific setter
methods require direct access to the parser instance, SAX
properties support configuration settings to be propagated through
a chain of filters
down to the
underlying parser object.
This mecanism shall be used to configure the
objects to be serialized
as
well as the XStream facade
.
Field Summary | |
---|---|
static java.lang.String |
CONFIGURED_XSTREAM_PROPERTY
The SAX property to configure the XStream
facade to be used for object serialization. |
static java.lang.String |
SOURCE_OBJECT_LIST_PROPERTY
The SAX property to configure the list of
Java objects to serialize. |
Constructor Summary | |
---|---|
SaxWriter()
|
|
SaxWriter(boolean includeEnclosingDocument)
|
Method Summary | |
---|---|
void |
addAttribute(java.lang.String name,
java.lang.String value)
|
void |
close()
Close the writer, if necessary. |
void |
endNode()
|
void |
flush()
Flush the writer, if necessary. |
org.xml.sax.ContentHandler |
getContentHandler()
Returns the current content handler. |
org.xml.sax.DTDHandler |
getDTDHandler()
Returns the current DTD handler. |
org.xml.sax.EntityResolver |
getEntityResolver()
Returns the current entity resolver. |
org.xml.sax.ErrorHandler |
getErrorHandler()
Returns the current error handler. |
boolean |
getFeature(java.lang.String name)
Looks up the value of a feature. |
java.lang.Object |
getProperty(java.lang.String name)
Looks up the value of a property. |
void |
parse(org.xml.sax.InputSource input)
Parse an XML document. |
void |
parse(java.lang.String systemId)
Parses an XML document from a system identifier (URI). |
void |
setContentHandler(org.xml.sax.ContentHandler handler)
Allows an application to register a content event handler. |
void |
setDTDHandler(org.xml.sax.DTDHandler handler)
Allows an application to register a DTD event handler. |
void |
setEntityResolver(org.xml.sax.EntityResolver resolver)
Allows an application to register an entity resolver. |
void |
setErrorHandler(org.xml.sax.ErrorHandler handler)
Allows an application to register an error event handler. |
void |
setFeature(java.lang.String name,
boolean value)
Sets the state of a feature. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Sets the value of a property. |
void |
setValue(java.lang.String text)
Write the value (text content) of the current node. |
void |
startNode(java.lang.String name)
|
void |
startNode(java.lang.String name,
java.lang.Class clazz)
|
HierarchicalStreamWriter |
underlyingWriter()
Return the underlying HierarchicalStreamWriter implementation. |
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractXmlWriter |
---|
escapeXmlName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONFIGURED_XSTREAM_PROPERTY
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.
public static final java.lang.String SOURCE_OBJECT_LIST_PROPERTY
SAX property
to configure the list of
Java objects to serialize. Setting this property prior
invoking one of the parse() methods is mandatory.
parse(java.lang.String)
,
parse(org.xml.sax.InputSource)
,
Constant Field ValuesConstructor Detail |
---|
public SaxWriter(boolean includeEnclosingDocument)
public SaxWriter()
Method Detail |
---|
public void setFeature(java.lang.String name, boolean value) throws org.xml.sax.SAXNotRecognizedException
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 implemention only supports the two
mandatory SAX features.
setFeature
in interface org.xml.sax.XMLReader
name
- the feature name, which is a fully-qualified URI.value
- the requested state of the feature (true or false).
org.xml.sax.SAXNotRecognizedException
- when the XMLReader does not
recognize the feature name.getFeature(java.lang.String)
public boolean getFeature(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException
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.
getFeature
in interface org.xml.sax.XMLReader
name
- the feature name, which is a fully-qualified URI.
org.xml.sax.SAXNotRecognizedException
- when the XMLReader does not
recognize the feature name.setFeature(java.lang.String, boolean)
public void setProperty(java.lang.String name, java.lang.Object value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
CONFIGURED_XSTREAM_PROPERTY
and SOURCE_OBJECT_LIST_PROPERTY
.
setProperty
in interface org.xml.sax.XMLReader
name
- the property name, which is a fully-qualified URI.value
- the requested value for the property.
org.xml.sax.SAXNotRecognizedException
- when the XMLReader does not
recognize the property name.
org.xml.sax.SAXNotSupportedException
- when the XMLReader recognizes
the property name but cannot set
the requested value.getProperty(java.lang.String)
public java.lang.Object getProperty(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException
getProperty
in interface org.xml.sax.XMLReader
name
- the property name, which is a fully-qualified URI.
org.xml.sax.SAXNotRecognizedException
- when the XMLReader does not
recognize the property name.getProperty(java.lang.String)
public void setEntityResolver(org.xml.sax.EntityResolver resolver)
setEntityResolver
in interface org.xml.sax.XMLReader
resolver
- the entity resolver.
java.lang.NullPointerException
- if the resolver argument is
null
.getEntityResolver()
public org.xml.sax.EntityResolver getEntityResolver()
getEntityResolver
in interface org.xml.sax.XMLReader
null
if none
has been registered.setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(org.xml.sax.DTDHandler handler)
setDTDHandler
in interface org.xml.sax.XMLReader
handler
- the DTD handler.
java.lang.NullPointerException
- if the handler argument is
null
.getDTDHandler()
public org.xml.sax.DTDHandler getDTDHandler()
getDTDHandler
in interface org.xml.sax.XMLReader
null
if none
has been registered.setDTDHandler(org.xml.sax.DTDHandler)
public void setContentHandler(org.xml.sax.ContentHandler handler)
setContentHandler
in interface org.xml.sax.XMLReader
handler
- the content handler.
java.lang.NullPointerException
- if the handler argument is
null
.getContentHandler()
public org.xml.sax.ContentHandler getContentHandler()
getContentHandler
in interface org.xml.sax.XMLReader
null
if none
has been registered.setContentHandler(org.xml.sax.ContentHandler)
public void setErrorHandler(org.xml.sax.ErrorHandler handler)
setErrorHandler
in interface org.xml.sax.XMLReader
handler
- the error handler.
java.lang.NullPointerException
- if the handler argument is
null
.getErrorHandler()
public org.xml.sax.ErrorHandler getErrorHandler()
getErrorHandler
in interface org.xml.sax.XMLReader
null
if none
has been registered.setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(java.lang.String systemId) throws org.xml.sax.SAXException
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 theparse(new InputSource(systemId));
systemId
argument of this method
and relies on the proprietary SAX property
SOURCE_OBJECT_LIST_PROPERTY
) to define the list of
objects to serialize.
parse
in interface org.xml.sax.XMLReader
systemId
- the system identifier (URI).
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping
another exception.parse(org.xml.sax.InputSource)
public void parse(org.xml.sax.InputSource input) throws org.xml.sax.SAXException
source
argument of this method
and relies on the proprietary SAX property
SOURCE_OBJECT_LIST_PROPERTY
) to define the list of
objects to serialize.
parse
in interface org.xml.sax.XMLReader
input
- The input source for the top-level of the
XML document.
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping
another exception.InputSource
,
parse(java.lang.String)
,
setEntityResolver(org.xml.sax.EntityResolver)
,
setDTDHandler(org.xml.sax.DTDHandler)
,
setContentHandler(org.xml.sax.ContentHandler)
,
setErrorHandler(org.xml.sax.ErrorHandler)
public void startNode(java.lang.String name)
startNode
in interface HierarchicalStreamWriter
public void startNode(java.lang.String name, java.lang.Class clazz)
startNode
in interface ExtendedHierarchicalStreamWriter
public void addAttribute(java.lang.String name, java.lang.String value)
addAttribute
in interface HierarchicalStreamWriter
public void setValue(java.lang.String text)
HierarchicalStreamWriter
setValue
in interface HierarchicalStreamWriter
public void endNode()
endNode
in interface HierarchicalStreamWriter
public void flush()
HierarchicalStreamWriter
flush
in interface HierarchicalStreamWriter
public void close()
HierarchicalStreamWriter
close
in interface HierarchicalStreamWriter
public HierarchicalStreamWriter underlyingWriter()
HierarchicalStreamWriter
If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).
For example:
MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT! mySpecificWriter.doSomethingSpecific();
MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter(); // CORRECT! mySpecificWriter.doSomethingSpecific();
Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.
underlyingWriter
in interface HierarchicalStreamWriter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |