Package org.gedcomx.util
Class CleanXMLStreamWriter
java.lang.Object
org.gedcomx.util.CleanXMLStreamWriter
- All Implemented Interfaces:
XMLStreamWriter
Delegating
XMLStreamWriter that filters out UTF-8 characters that
are illegal in XML, replacing them with a- Author:
- Erik van Zijst (small change by Lennart Schedin, and isLegalXmlCharacter() expanded to XML 1.0 spec by Randy Wilson)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()protected static StringescapeCharacters(String string) Substitutes all illegal characters in the given string by the value ofREPLACEMENT_CHARACTER.voidflush()protected static booleanisLegalXmlCodePoint(int c) Tell whether the given character is valid in an XML document.voidvoidsetNamespaceContext(NamespaceContext namespaceContext) voidvoidwriteAttribute(String localName, String value) voidwriteAttribute(String namespaceUri, String localName, String value) voidwriteAttribute(String prefix, String namespaceUri, String localName, String value) voidwriteCData(String s) voidwriteCharacters(char[] chars, int start, int len) voidvoidvoidvoidvoidvoidwriteEmptyElement(String s, String s1) voidwriteEmptyElement(String s, String s1, String s2) voidvoidvoidvoidwriteNamespace(String s, String s1) voidvoidvoidvoidvoidwriteStartDocument(String s, String s1) voidvoidwriteStartElement(String s, String s1) voidwriteStartElement(String s, String s1, String s2)
-
Field Details
-
REPLACEMENT_CHARACTER
public static final char REPLACEMENT_CHARACTER- See Also:
-
-
Constructor Details
-
CleanXMLStreamWriter
-
-
Method Details
-
escapeCharacters
Substitutes all illegal characters in the given string by the value ofREPLACEMENT_CHARACTER. If no illegal characters were found, no copy is made and the given string is returned.- Parameters:
string- the string- Returns:
- same string, if not illegal characters detected;
otherwise, string with illegal characters replaced with
REPLACEMENT_CHARACTER
-
writeStartElement
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndElement
- Specified by:
writeEndElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndDocument
- Specified by:
writeEndDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
close
- Specified by:
closein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
flush
- Specified by:
flushin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceUri, String localName, String value) throws XMLStreamException - Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceUri, String localName, String value) throws XMLStreamException - Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeNamespace
- Specified by:
writeNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDefaultNamespace
- Specified by:
writeDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeComment
- Specified by:
writeCommentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCData
- Specified by:
writeCDatain interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDTD
- Specified by:
writeDTDin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEntityRef
- Specified by:
writeEntityRefin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getPrefix
- Specified by:
getPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setPrefix
- Specified by:
setPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setDefaultNamespace
- Specified by:
setDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setNamespaceContext
- Specified by:
setNamespaceContextin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getNamespaceContext
- Specified by:
getNamespaceContextin interfaceXMLStreamWriter
-
getProperty
- Specified by:
getPropertyin interfaceXMLStreamWriter- Throws:
IllegalArgumentException
-
isLegalXmlCodePoint
protected static boolean isLegalXmlCodePoint(int c) Tell whether the given character is valid in an XML document.- Parameters:
c- - character- Returns:
- true if valid in XML, false if it would make an XML invalid.
-