public final class SaxWriter extends AbstractXmlWriter implements 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 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
CONFIGURED_XSTREAM_PROPERTY
The
SAX property to configure the XStream
facade to be used for object serialization. |
static String |
SOURCE_OBJECT_LIST_PROPERTY
The
SAX property to configure the list of
Java objects to serialize. |
| Constructor and Description |
|---|
SaxWriter() |
SaxWriter(boolean includeEnclosingDocument) |
SaxWriter(boolean includeEnclosingDocument,
XmlFriendlyReplacer replacer) |
SaxWriter(XmlFriendlyReplacer replacer) |
| Modifier and Type | Method and Description |
|---|---|
void |
addAttribute(String name,
String value) |
void |
close()
Close the writer, if necessary.
|
void |
endNode() |
void |
flush()
Flush the writer, if necessary.
|
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)
Write the value (text content) of the current node.
|
void |
startNode(String name) |
escapeXmlName, startNode, underlyingWriterpublic static final 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 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.public SaxWriter(XmlFriendlyReplacer replacer)
public SaxWriter(boolean includeEnclosingDocument,
XmlFriendlyReplacer replacer)
public SaxWriter(boolean includeEnclosingDocument)
public SaxWriter()
public void setFeature(String name, boolean value) throws 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 implementation only supports the two
mandatory SAX features.setFeature in interface XMLReadername - the feature name, which is a fully-qualified URI.value - the requested state of the feature (true or false).SAXNotRecognizedException - when the XMLReader does not
recognize the feature name.getFeature(java.lang.String)public boolean getFeature(String name) throws 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 XMLReadername - the feature name, which is a fully-qualified URI.SAXNotRecognizedException - when the XMLReader does not
recognize the feature name.setFeature(java.lang.String, boolean)public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
CONFIGURED_XSTREAM_PROPERTY
and SOURCE_OBJECT_LIST_PROPERTY.setProperty in interface XMLReadername - the property name, which is a fully-qualified URI.value - the requested value for the property.SAXNotRecognizedException - when the XMLReader does not
recognize the property name.SAXNotSupportedException - when the XMLReader recognizes
the property name but cannot set
the requested value.getProperty(java.lang.String)public Object getProperty(String name) throws SAXNotRecognizedException
getProperty in interface XMLReadername - the property name, which is a fully-qualified URI.SAXNotRecognizedException - when the XMLReader does not
recognize the property name.getProperty(java.lang.String)public void setEntityResolver(EntityResolver resolver)
setEntityResolver in interface XMLReaderresolver - the entity resolver.NullPointerException - if the resolver argument is
null.getEntityResolver()public EntityResolver getEntityResolver()
getEntityResolver in interface XMLReadernull if none
has been registered.setEntityResolver(org.xml.sax.EntityResolver)public void setDTDHandler(DTDHandler handler)
setDTDHandler in interface XMLReaderhandler - the DTD handler.NullPointerException - if the handler argument is
null.getDTDHandler()public DTDHandler getDTDHandler()
getDTDHandler in interface XMLReadernull if none
has been registered.setDTDHandler(org.xml.sax.DTDHandler)public void setContentHandler(ContentHandler handler)
setContentHandler in interface XMLReaderhandler - the content handler.NullPointerException - if the handler argument is
null.getContentHandler()public ContentHandler getContentHandler()
getContentHandler in interface XMLReadernull if none
has been registered.setContentHandler(org.xml.sax.ContentHandler)public void setErrorHandler(ErrorHandler handler)
setErrorHandler in interface XMLReaderhandler - the error handler.NullPointerException - if the handler argument is
null.getErrorHandler()public ErrorHandler getErrorHandler()
getErrorHandler in interface XMLReadernull if none
has been registered.setErrorHandler(org.xml.sax.ErrorHandler)public void parse(String systemId) throws SAXException
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.parse in interface XMLReadersystemId - the system identifier (URI).SAXException - Any SAX exception, possibly wrapping
another exception.parse(org.xml.sax.InputSource)public void parse(InputSource input) throws 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 XMLReaderinput - The input source for the top-level of the
XML document.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(String name)
startNode in interface HierarchicalStreamWriterpublic void addAttribute(String name, String value)
addAttribute in interface HierarchicalStreamWriterpublic void setValue(String text)
HierarchicalStreamWritersetValue in interface HierarchicalStreamWriterpublic void endNode()
endNode in interface HierarchicalStreamWriterpublic void flush()
HierarchicalStreamWriterflush in interface HierarchicalStreamWriterpublic void close()
HierarchicalStreamWriterclose in interface HierarchicalStreamWriterCopyright © 2020 Internet2. All rights reserved.