Package org.apache.logging.log4j.core.util

Class Transform

  • public final class Transform
extends java.lang.Object
    Utility class for transforming strings.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Transform()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void appendEscapingCData​(java.lang.StringBuilder buf, java.lang.String str)
      Ensures that embedded CDEnd strings (]]>) are handled properly within message, NDC and throwable tag text.
      static java.lang.String escapeHtmlTags​(java.lang.String input)
      This method takes a string which may contain HTML tags (ie, <b>, <table>, etc) and replaces any '<', '>' , '&' or '"' characters with respective predefined entity references.
      static java.lang.String escapeJsonControlCharacters​(java.lang.String input)
      This method takes a string which may contain JSON reserved chars and escapes them.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • CDATA_PSEUDO_END

        private static final java.lang.String CDATA_PSEUDO_END
        See Also:
        Constant Field Values

      • CDATA_EMBEDED_END

        private static final java.lang.String CDATA_EMBEDED_END
        See Also:
        Constant Field Values

      • CDATA_END_LEN

        private static final int CDATA_END_LEN

    • Constructor Detail

      • Transform

        private Transform()

    • Method Detail

      • escapeHtmlTags

        public static java.lang.String escapeHtmlTags​(java.lang.String input)
        This method takes a string which may contain HTML tags (ie, <b>, <table>, etc) and replaces any '<', '>' , '&' or '"' characters with respective predefined entity references.
        Parameters:
        input - The text to be converted.
        Returns:
        The input string with the special characters replaced.

      • appendEscapingCData

        public static void appendEscapingCData​(java.lang.StringBuilder buf,
                                       java.lang.String str)
        Ensures that embedded CDEnd strings (]]>) are handled properly within message, NDC and throwable tag text.
        Parameters:
        buf - StringBuilder holding the XML data to this point. The initial CDStart (<![CDATA[) and final CDEnd (]]>) of the CDATA section are the responsibility of the calling method.
        str - The String that is inserted into an existing CDATA Section within buf.

      • escapeJsonControlCharacters

        public static java.lang.String escapeJsonControlCharacters​(java.lang.String input)
        This method takes a string which may contain JSON reserved chars and escapes them.
        Parameters:
        input - The text to be converted.
        Returns:
        The input string with the special characters replaced.