Package org.apache.ws.commons.serialize
Class DOMSerializer
java.lang.Object
org.apache.ws.commons.serialize.DOMSerializer
Serializes a DOM node into a stream of SAX events.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate booleanprivate booleanprivate boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate voidcharacters(ContentHandler pHandler, String pValue, boolean pCdata) protected voiddoSerialize(Node pNode, ContentHandler pHandler) Converts the given nodepNodeinto a stream of SAX events, which are fired into the content handlerpHandler.protected voiddoSerializeChilds(Node pNode, ContentHandler pHandler) Serializes the childs ofpNode.private voidendPrefixMappingEvents(Node pNode, ContentHandler pHandler) Creates endPrefixMapping events for the nodepNode.booleanReturns whether XML declarations are being serialized as attributes or as SAX events (default).booleanSets whether XML declarations present in the parent nodes are being serialized (default) or not.booleanReturns, whetherstartDocumentandendDocumentevents are generated for document nodes.private voidparentsEndPrefixMappingEvents(Node pNode, ContentHandler pHandler) Finally creates endPrefixMapping events for the nodes parents.private voidparentsStartPrefixMappingEvents(Node pNode, ContentHandler pHandler) Initially creates startPrefixMapping events for the nodes parents.voidserialize(Node pNode, ContentHandler pHandler) Converts the given nodepNodeinto a stream of SAX events, which are fired into the content handlerpHandler.voidsetNamespaceDeclarationAttribute(boolean pXmlDeclarationAttribute) Sets whether XML namespace declarations are being serialized as attributes or as SAX events (default).voidsetParentsNamespaceDeclarationDisabled(boolean pParentsXmlDeclarationDisabled) Returns whether XML declarations present in the parent nodes are being serialized (default) or not.voidsetStartingDocument(boolean pStartingDocument) Sets, whetherstartDocumentandendDocumentevents are generated for document nodes.private voidstartPrefixMappingEvents(Node pNode, ContentHandler pHandler) Creates startPrefixMapping events for the nodepNode.
-
Field Details
-
namespaceDeclarationAttribute
private boolean namespaceDeclarationAttribute -
parentsNamespaceDeclarationDisabled
private boolean parentsNamespaceDeclarationDisabled -
startingDocument
private boolean startingDocument
-
-
Constructor Details
-
DOMSerializer
public DOMSerializer()
-
-
Method Details
-
setNamespaceDeclarationAttribute
public void setNamespaceDeclarationAttribute(boolean pXmlDeclarationAttribute) Sets whether XML namespace declarations are being serialized as attributes or as SAX events (default).- Parameters:
pXmlDeclarationAttribute- True, if a namespace declaration is being transmitted as an XML attribute. False otherwise.
-
isNamespaceDeclarationAttribute
public boolean isNamespaceDeclarationAttribute()Returns whether XML declarations are being serialized as attributes or as SAX events (default).- Returns:
- True, if a namespace declaration is being transmitted as an XML attribute. False otherwise.
-
setParentsNamespaceDeclarationDisabled
public void setParentsNamespaceDeclarationDisabled(boolean pParentsXmlDeclarationDisabled) Returns whether XML declarations present in the parent nodes are being serialized (default) or not. This option takes effect only if the namespace declarations are sent as events. In other words, if thenamespaceDeclarationAttributeproperts is false.- Parameters:
pParentsXmlDeclarationDisabled- True, if namespace declarations of the parent nodes are disabled, false otherwise.
-
isParentsNamespaceDeclarationDisabled
public boolean isParentsNamespaceDeclarationDisabled()Sets whether XML declarations present in the parent nodes are being serialized (default) or not. This option takes effect only if the namespace declarations are sent as events. In other words, if thenamespaceDeclarationAttributeproperts is false.- Returns:
- True, if namespace declarations of the parent nodes are disabled, false otherwise.
-
isStartingDocument
public boolean isStartingDocument()Returns, whetherstartDocumentandendDocumentevents are generated for document nodes.- Returns:
- True (default), if
startDocumentandendDocumentevents are being generated. False otherwise.
-
setStartingDocument
public void setStartingDocument(boolean pStartingDocument) Sets, whetherstartDocumentandendDocumentevents are generated for document nodes.- Parameters:
pStartingDocument- True (default), ifstartDocumentandendDocumentevents are being generated. False otherwise.
-
doSerializeChilds
Serializes the childs ofpNode.- Parameters:
pNode- The parent node, whose childs are being serialized.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
parentsStartPrefixMappingEvents
private void parentsStartPrefixMappingEvents(Node pNode, ContentHandler pHandler) throws SAXException Initially creates startPrefixMapping events for the nodes parents. This is invoked only, ifisNamespaceDeclarationAttribute(), andisParentsNamespaceDeclarationDisabled()are false.- Parameters:
pNode- The node, for which namespace declarations are being created.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
parentsEndPrefixMappingEvents
Finally creates endPrefixMapping events for the nodes parents. This is invoked only, ifisNamespaceDeclarationAttribute(), andisParentsNamespaceDeclarationDisabled()are false.- Parameters:
pNode- The node, for which namespace declarations are being created.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
startPrefixMappingEvents
Creates startPrefixMapping events for the nodepNode.- Parameters:
pNode- The node being serialized.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
endPrefixMappingEvents
Creates endPrefixMapping events for the nodepNode.- Parameters:
pNode- The node being serialized.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
characters
- Throws:
SAXException
-
serialize
Converts the given nodepNodeinto a stream of SAX events, which are fired into the content handlerpHandler.- Parameters:
pNode- The node being serialized.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-
doSerialize
Converts the given nodepNodeinto a stream of SAX events, which are fired into the content handlerpHandler. Unlikeserialize(Node, ContentHandler), this method doesn't callparentsStartPrefixMappingEvents(Node, ContentHandler), andparentsEndPrefixMappingEvents(Node, ContentHandler).- Parameters:
pNode- The node being serialized.pHandler- The target handler.- Throws:
SAXException- The target handler reported an error.
-