Package com.helger.xml.serialize.write

Class XMLMaskHelper

java.lang.Object

com.helger.xml.serialize.write.XMLMaskHelper

public final class XMLMaskHelper
extends Object

This class contains all the methods for masking XML content.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static String	getHTMLEntityReferenceString(char c)	Get the entity reference for the specified character.
static char[]	getMaskedXMLText(EXMLSerializeVersion eXMLVersion, EXMLCharMode eXMLCharMode, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String s)
static int	getMaskedXMLTextLength(EXMLVersion eXMLVersion, EXMLCharMode eXMLCharMode, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String s)
static int	getMaskedXMLTextLength(EXMLSerializeVersion eXMLVersion, EXMLCharMode eXMLCharMode, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String s)
static String	getXML10EntityReferenceString(char c)	Get the entity reference for the specified character.
static String	getXML11EntityReferenceString(char c)	Get the entity reference for the specified character.
static String	getXMLNumericReference(char n)
static void	maskXMLTextTo(EXMLSerializeVersion eXMLVersion, EXMLCharMode eXMLCharMode, EXMLIncorrectCharacterHandling eIncorrectCharHandling, char[] aSrcText, int nOfs, int nLen, Writer aWriter)
static void	maskXMLTextTo(EXMLSerializeVersion eXMLVersion, EXMLCharMode eXMLCharMode, EXMLIncorrectCharacterHandling eIncorrectCharHandling, String s, Writer aWriter)

Methods inherited from class java.lang.Object

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

Method Details

getXMLNumericReference

@Nonnull
public static String getXMLNumericReference(char n)

getXML10EntityReferenceString

@Nonnull
@Nonempty
public static String getXML10EntityReferenceString(char c)

Get the entity reference for the specified character. This returns e.g. &lt; for '<' etc. This method has special handling for <, >, &, " and '. All other chars are encoded by their numeric value (e.g. &#200;)

Parameters:

c - Character to use.

Returns:

The entity reference string. Never null nor empty.

getXML11EntityReferenceString

@Nonnull
@Nonempty
public static String getXML11EntityReferenceString(char c)

Get the entity reference for the specified character. This returns e.g. &lt; for '<' etc. This method has special handling for <, >, &, " and '. All other chars are encoded by their numeric value (e.g. &#200;)

Parameters:

c - Character to use.

Returns:

The entity reference string. Never null nor empty.

getHTMLEntityReferenceString

@Nonnull
@Nonempty
public static String getHTMLEntityReferenceString(char c)

Get the entity reference for the specified character. This returns e.g. < for '<' etc. This method has special handling for <, >, & and ". All other chars are encoded by their numeric value (e.g. È). In contrast to getXML10EntityReferenceString(char) this method does not handle '

Parameters:

c - Character to use.

Returns:

The entity reference string. Never null nor empty.

getMaskedXMLText

@Nonnull
public static char[] getMaskedXMLText(@Nonnull
 EXMLSerializeVersion eXMLVersion,
 @Nonnull
 EXMLCharMode eXMLCharMode,
 @Nonnull
 EXMLIncorrectCharacterHandling eIncorrectCharHandling,
 @Nullable
 String s)

getMaskedXMLTextLength

@Nonnegative
public static int getMaskedXMLTextLength(@Nonnull
 EXMLVersion eXMLVersion,
 @Nonnull
 EXMLCharMode eXMLCharMode,
 @Nonnull
 EXMLIncorrectCharacterHandling eIncorrectCharHandling,
 @Nullable
 String s)

getMaskedXMLTextLength

@Nonnegative
public static int getMaskedXMLTextLength(@Nonnull
 EXMLSerializeVersion eXMLVersion,
 @Nonnull
 EXMLCharMode eXMLCharMode,
 @Nonnull
 EXMLIncorrectCharacterHandling eIncorrectCharHandling,
 @Nullable
 String s)

maskXMLTextTo

public static void maskXMLTextTo(@Nonnull
 EXMLSerializeVersion eXMLVersion,
 @Nonnull
 EXMLCharMode eXMLCharMode,
 @Nonnull
 EXMLIncorrectCharacterHandling eIncorrectCharHandling,
 @Nullable
 String s,
 @Nonnull
 Writer aWriter)
                          throws IOException

Throws:

IOException

maskXMLTextTo

public static void maskXMLTextTo(@Nonnull
 EXMLSerializeVersion eXMLVersion,
 @Nonnull
 EXMLCharMode eXMLCharMode,
 @Nonnull
 EXMLIncorrectCharacterHandling eIncorrectCharHandling,
 @Nonnull
 char[] aSrcText,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen,
 @Nonnull
 Writer aWriter)
                          throws IOException

Throws:

IOException