Package net.sf.jasperreports.engine.util

Class JRStringUtil

  • public final class JRStringUtil
extends java.lang.Object
    Author:
    Teodor Danciu (teodord@users.sourceforge.net)

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static java.lang.String cssClassReplacement​(java.lang.String text)  
      static java.lang.String encodeXmlAttribute​(java.lang.String text)  
      static java.lang.String encodeXmlAttribute​(java.lang.String text, boolean exceptApos)  
      static java.lang.String escapeJavaScript​(java.lang.String input)
      Escapes a text so that it can be used as a Java String literal.
      static java.lang.String escapeJavaStringLiteral​(java.lang.String text)
      Escapes a text so that it can be used as a Java String literal.
      static java.lang.String escapeJSONString​(java.lang.String text)
      Escapes a text to be used for a JSON string value.
      static java.lang.String escapeString4JavaScript​(java.lang.String input)
      Escapes a Java String so that it can be used as a JavaScript String literal.
      static java.lang.String getCSSClass​(java.lang.String name)  
      static java.lang.String getJavaIdentifier​(java.lang.String name)
      Takes a name and returns the same if it is a Java identifier; else it substitutes the illegal characters so that it can be an identifier
      static java.lang.String getLetterNumeral​(int number, boolean isUpperCase)  
      static java.lang.String getRomanNumeral​(int number, boolean isUpperCase)  
      static java.lang.String getString​(java.lang.Object value)  
      static java.util.List<java.lang.Integer> getTabIndexes​(java.lang.String text)  
      static java.lang.String htmlEncode​(java.lang.String text)  
      static java.lang.String replaceCRwithLF​(java.lang.String text)
      This method replaces all occurrences of the CR character with the LF character, except when the CR is immediately followed by a LF (CRLF sequences), in which case the CR is removed.
      static java.util.List<java.lang.String> split​(java.lang.String[] srcArray, java.lang.String delimiterRegExp)  
      static java.lang.String xmlEncode​(java.lang.String text)  
      static java.lang.String xmlEncode​(java.lang.String text, java.lang.String invalidCharReplacement)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • JAVA_IDENTIFIER_PREFIX

        protected static final java.lang.String JAVA_IDENTIFIER_PREFIX
        See Also:
        Constant Field Values

      • PATTERN_CSS_INVALID_CHARACTER

        protected static final java.util.regex.Pattern PATTERN_CSS_INVALID_CHARACTER

      • HEX_DIGITS

        protected static final char[] HEX_DIGITS

      • EXCEPTION_MESSAGE_KEY_NUMBER_OUTSIDE_BOUNDS

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_NUMBER_OUTSIDE_BOUNDS
        See Also:
        Constant Field Values

      • THOUSAND_DIGITS

        protected static final java.lang.String[] THOUSAND_DIGITS

      • HUNDRED_DIGITS

        protected static final java.lang.String[] HUNDRED_DIGITS

      • TEN_DIGITS

        protected static final java.lang.String[] TEN_DIGITS

      • UNIT_DIGITS

        protected static final java.lang.String[] UNIT_DIGITS

    • Method Detail

      • replaceCRwithLF

        public static java.lang.String replaceCRwithLF​(java.lang.String text)
        This method replaces all occurrences of the CR character with the LF character, except when the CR is immediately followed by a LF (CRLF sequences), in which case the CR is removed.

      • xmlEncode

        public static java.lang.String xmlEncode​(java.lang.String text)

      • xmlEncode

        public static java.lang.String xmlEncode​(java.lang.String text,
                                         java.lang.String invalidCharReplacement)

      • encodeXmlAttribute

        public static java.lang.String encodeXmlAttribute​(java.lang.String text)

      • encodeXmlAttribute

        public static java.lang.String encodeXmlAttribute​(java.lang.String text,
                                                  boolean exceptApos)

      • htmlEncode

        public static java.lang.String htmlEncode​(java.lang.String text)

      • getJavaIdentifier

        public static java.lang.String getJavaIdentifier​(java.lang.String name)
        Takes a name and returns the same if it is a Java identifier; else it substitutes the illegal characters so that it can be an identifier
        Parameters:
        name -

      • escapeJavaStringLiteral

        public static java.lang.String escapeJavaStringLiteral​(java.lang.String text)
        Escapes a text so that it can be used as a Java String literal.
        Parameters:
        text - the text
        Returns:
        the text with escaped quotes and backslashes

      • escapeJavaScript

        public static java.lang.String escapeJavaScript​(java.lang.String input)
        Escapes a text so that it can be used as a Java String literal.
        Parameters:
        input -

      • escapeString4JavaScript

        public static java.lang.String escapeString4JavaScript​(java.lang.String input)
        Escapes a Java String so that it can be used as a JavaScript String literal.
        Parameters:
        input -

      • getTabIndexes

        public static java.util.List<java.lang.Integer> getTabIndexes​(java.lang.String text)

      • split

        public static java.util.List<java.lang.String> split​(java.lang.String[] srcArray,
                                                     java.lang.String delimiterRegExp)

      • getString

        public static java.lang.String getString​(java.lang.Object value)

      • escapeJSONString

        public static java.lang.String escapeJSONString​(java.lang.String text)
        Escapes a text to be used for a JSON string value.
        Parameters:
        text - the text to escape for JSON
        Returns:
        the escaped text if not null

      • getCSSClass

        public static java.lang.String getCSSClass​(java.lang.String name)

      • cssClassReplacement

        protected static java.lang.String cssClassReplacement​(java.lang.String text)

      • getLetterNumeral

        public static java.lang.String getLetterNumeral​(int number,
                                                boolean isUpperCase)

      • getRomanNumeral

        public static java.lang.String getRomanNumeral​(int number,
                                               boolean isUpperCase)
        Parameters:
        number - an integer value between 1 and 3999
        isUpperCase - specifies whether the result should be made of upper case characters
        Returns:
        the Roman numeral representation of this number