org.finra.herd.dao.helper

Class HerdCharacterEscapeHandler

java.lang.Object

org.finra.herd.dao.helper.HerdCharacterEscapeHandler

All Implemented Interfaces:

org.eclipse.persistence.internal.oxm.CharacterEscapeHandler

@Component
public class HerdCharacterEscapeHandler
extends Object
implements org.eclipse.persistence.oxm.CharacterEscapeHandler

A custom escape handler that escapes XML 1.1 restricted characters (http://www.w3.org/TR/xml11/#charsets).

Constructor Summary

Constructors

Constructor and Description
HerdCharacterEscapeHandler()

Method Summary

Modifier and Type	Method and Description
void	escape(char[] buffer, int start, int length, boolean isAttributeValue, Writer outputWriter) Escape restricted XML 1.1 characters inside the buffer and send the output to the Writer.
static boolean	isXml11RestrictedCharacter(char ch) Returns whether the specified character is XML 1.1 restricted.

Methods inherited from class java.lang.Object

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

Constructor Detail

HerdCharacterEscapeHandler

public HerdCharacterEscapeHandler()

Method Detail

escape

public void escape(char[] buffer,
                   int start,
                   int length,
                   boolean isAttributeValue,
                   Writer outputWriter)
            throws IOException

Escape restricted XML 1.1 characters inside the buffer and send the output to the Writer. The "&", "<", and ">" characters are always escaped. Single and double quotes are escaped when within an attribute. All XML 1.1 restricted characters are escaped using "&#x(value);".

Specified by:

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

Parameters:

buffer - the buffer.

start - the start of the buffer.

length - the length of the buffer.

isAttributeValue - Flag that determines whether the buffer is an XML attribute or not.

outputWriter - the output writer.

Throws:

IOException - which will stop the marshalling process.

isXml11RestrictedCharacter

public static boolean isXml11RestrictedCharacter(char ch)

Returns whether the specified character is XML 1.1 restricted.

Parameters:

ch - the character to check.

Returns:

True if the character is restricted or false if not.