org.eclipse.persistence.oxm

Interface CharacterEscapeHandler

All Superinterfaces:

org.eclipse.persistence.internal.oxm.CharacterEscapeHandler

public interface CharacterEscapeHandler
extends org.eclipse.persistence.internal.oxm.CharacterEscapeHandler

Provide an interface to allow for custom character escaping behaviour.

Method Summary

Modifier and Type	Method and Description
void	escape(char[] buffer, int start, int length, boolean isAttributeValue, java.io.Writer out) Perform character escaping and write the result to the output.

Method Detail

escape

void escape(char[] buffer,
            int start,
            int length,
            boolean isAttributeValue,
            java.io.Writer out)
     throws java.io.IOException

Perform character escaping and write the result to the output.

Note: This feature is not supported when marshalling to the following targets:

• javax.xml.stream.XMLStreamWriter
• javax.xml.stream.XMLEventWriter
• org.xml.sax.ContentHandler
• org.w3c.dom.Node

Specified by:

escape in interface org.eclipse.persistence.internal.oxm.CharacterEscapeHandler

Parameters:

buffer - Array of characters to be escaped

start - The starting position

length - The number of characters being escaped

isAttributeValue - A value of 'true' indicates this is an attribute value

out - The resulting escaped characters will be written to this Writer

Throws:

java.io.IOException - In an error condition, IOException can be thrown to stop the marshalling process