com.helger.xml.serialize.write

Class SafeXMLStreamWriter

java.lang.Object

com.helger.xml.serialize.write.SafeXMLStreamWriter

All Implemented Interfaces:

AutoCloseable, XMLStreamWriter

public class SafeXMLStreamWriter
extends Object
implements XMLStreamWriter, AutoCloseable

A special stream writer, that ensures that special XML characters are handled correctly.
See https://github.com/javaee/jaxb-v2/issues/614
See https://github.com/javaee/jaxb-v2/issues/960

Since:

9.0.0

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SafeXMLStreamWriter(XMLEmitter aEmitter)

Method Summary

Modifier and Type	Method and Description
void	close()
static SafeXMLStreamWriter	create(OutputStream aOS, IXMLWriterSettings aSettings)
static SafeXMLStreamWriter	create(Writer aWriter, IXMLWriterSettings aSettings)
protected void	debug(Supplier<String> aSupplier)
void	flush()
NamespaceContext	getNamespaceContext()
String	getPrefix(String sUri)
Object	getProperty(String sName)
boolean	isDebugMode()
static boolean	isDefaultDebugMode()
SafeXMLStreamWriter	setDebugMode(boolean bDebugMode) Enable or disable debug mode
static void	setDefaultDebugMode(boolean bDefaultDebugMode)
void	setDefaultNamespace(String sUri)
void	setNamespaceContext(NamespaceContext aContext)
void	setPrefix(String sPrefix, String sUri)
String	toString()
void	writeAttribute(String sLocalName, String sValue)
void	writeAttribute(String sNamespaceURI, String sLocalName, String sValue)
void	writeAttribute(String sPrefix, String sNamespaceURI, String sLocalName, String sValue)
void	writeCData(String sData)
void	writeCharacters(char[] aText, int nStart, int nLen)
void	writeCharacters(String sText)
void	writeComment(String sData)
void	writeDefaultNamespace(String sNamespaceURI)
void	writeDTD(String sDTD)
void	writeEmptyElement(String sLocalName)
void	writeEmptyElement(String sNamespaceURI, String sLocalName)
void	writeEmptyElement(String sPrefix, String sLocalName, String sNamespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String sName)
void	writeNamespace(String sPrefix, String sNamespaceURI)
void	writeProcessingInstruction(String sTarget)
void	writeProcessingInstruction(String sTarget, String sData)
void	writeStartDocument()
void	writeStartDocument(Charset aEncoding, EXMLVersion eVersion)
void	writeStartDocument(String sVersion)
void	writeStartDocument(String sEncoding, String sVersion)
void	writeStartElement(String sLocalName)
void	writeStartElement(String sNamespaceURI, String sLocalName)
void	writeStartElement(String sPrefix, String sLocalName, String sNamespaceURI)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SafeXMLStreamWriter

public SafeXMLStreamWriter(@Nonnull
                           XMLEmitter aEmitter)

Method Detail

isDefaultDebugMode

public static boolean isDefaultDebugMode()

setDefaultDebugMode

public static void setDefaultDebugMode(boolean bDefaultDebugMode)

isDebugMode

public final boolean isDebugMode()

Returns:

true if debug mode is enabled, false if it is disabled. By default it is disabled.

See Also:

setDebugMode(boolean)

setDebugMode

@Nonnull
public final SafeXMLStreamWriter setDebugMode(boolean bDebugMode)

Enable or disable debug mode

Parameters:

bDebugMode - true to enable debug mode, false to disable it.

Returns:

this for chaining

See Also:

isDebugMode()

debug

@OverrideOnDemand
protected void debug(@Nonnull
                                        Supplier<String> aSupplier)

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(@Nullable
                               String sVersion)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(@Nonnull
                               String sEncoding,
                               @Nullable
                               String sVersion)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(@Nonnull
                               Charset aEncoding,
                               @Nonnull
                               EXMLVersion eVersion)

writeDTD

public void writeDTD(@Nonnull
                     String sDTD)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String sLocalName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(@Nullable
                              String sNamespaceURI,
                              String sLocalName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(@Nullable
                              String sPrefix,
                              String sLocalName,
                              @Nullable
                              String sNamespaceURI)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String sLocalName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(@Nullable
                              String sNamespaceURI,
                              String sLocalName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(@Nullable
                              String sPrefix,
                              String sLocalName,
                              @Nullable
                              String sNamespaceURI)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String sLocalName,
                           String sValue)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(@Nullable
                           String sNamespaceURI,
                           String sLocalName,
                           String sValue)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(@Nullable
                           String sPrefix,
                           @Nullable
                           String sNamespaceURI,
                           String sLocalName,
                           String sValue)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(@Nullable
                           String sPrefix,
                           @Nonnull
                           String sNamespaceURI)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(@Nonnull
                                  String sNamespaceURI)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeComment

public void writeComment(String sData)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Throws:

XMLStreamException

writeCData

public void writeCData(String sData)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String sName)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String sText)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] aText,
                            int nStart,
                            int nLen)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(@Nonnull
                                       String sTarget)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(@Nonnull
                                       String sTarget,
                                       @Nullable
                                       String sData)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

getPrefix

public String getPrefix(@Nonnull
                        String sUri)
                 throws XMLStreamException

Specified by:

getPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setPrefix

public void setPrefix(@Nonnull
                      String sPrefix,
                      @Nonnull
                      String sUri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(@Nonnull
                                String sUri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(@Nullable
                                NamespaceContext aContext)
                         throws XMLStreamException

Specified by:

setNamespaceContext in interface XMLStreamWriter

Throws:

XMLStreamException

getNamespaceContext

@Nonnull
public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter

getProperty

@Nullable
public Object getProperty(String sName)

Specified by:

getProperty in interface XMLStreamWriter

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static SafeXMLStreamWriter create(@Nonnull @WillCloseWhenClosed
                                                   Writer aWriter,
                                                   @Nonnull
                                                   IXMLWriterSettings aSettings)

create

@Nonnull
public static SafeXMLStreamWriter create(@Nonnull @WillCloseWhenClosed
                                                   OutputStream aOS,
                                                   @Nonnull
                                                   IXMLWriterSettings aSettings)