StringUtil

Description

  • org.joget.commons.util.StringUtil
  • Under wflow-commons module
  • Utility methods for String processing

 

Code Sample

import org.joget.commons.util.StringUtil;
  
String html = "<p>This is a test string</p>";
String stripped = StringUtil.stripAllHtmlTag(html);

 

Fields

TYPE_HTML

public static final java.lang.String TYPE_HTML = "html";

Used for escapeString method for escape format to escape HTML syntax.

 

TYPE_JAVA

public static final java.lang.String TYPE_JAVA = "java";

Used for escapeString method for escape format to escape Java syntax.

 

TYPE_JAVASCIPT

public static final java.lang.String TYPE_JAVASCIPT = "javascript";

Used for escapeString method for escape format to escape javascript syntax.

 

TYPE_JSON

public static final java.lang.String TYPE_JSON = "json";

Used for escapeString method for escape format to escape json syntax.

 

TYPE_REGEX

public static final java.lang.String TYPE_REGEX = "regex";

Used for escapeString method for escape format to escape regex syntax.

 

TYPE_SQL

public static final java.lang.String TYPE_SQL = "sql";

Used for escapeString method for escape format to escape SQL syntax.

 

TYPE_URL

public static final java.lang.String TYPE_URL = "url";

Used for escapeString method for escape format to encode url parameter value.

 

TYPE_XML

public static final java.lang.String TYPE_XML = "xml";

Used for escapeString method for escape format to escape XML syntax.

 

Methods

addParamsToUrl

public static java.lang.String addParamsToUrl(java.lang.String url, java.lang.String paramKey, java.lang.String paramValue)

Add parameter and its value to URL. Override the value if the parameter exists in the URL.

 

addParamsToUrl

public static java.lang.String addParamsToUrl(java.lang.String url, java.lang.String paramKey, java.lang.String[] paramValues)

Add parameter and its values to URL. Override the value if the parameter exists in the URL.

 

addParamsToUrl

public static java.lang.String addParamsToUrl(java.lang.String url, java.util.Map<java.lang.String, java.lang.String[]> params)

Add parameters and their values to the URL. Override the value if the parameter exists in the URL.

 

constructUrlQueryString

public static java.lang.String constructUrlQueryString(java.util.Map<java.lang.String, java.lang.String[]> params)

Builds a query string based on parameters and values.

 

encodeUrlParam

public static java.lang.String encodeUrlParam(java.lang.String url)

Method used to properly encode the parameters in a URL string.

 

mergeRequestQueryString

public static java.lang.String mergeRequestQueryString(java.lang.String queryString1, java.lang.String queryString2)

Method used to merge 2 query strings. If the same parameter is found, the one from the second query string will override the first query string.

 

escapeRegex

public static java.lang.String escapeRegex(java.lang.String inStr)

Escape regex syntax in a string.

 

escapeString

public static java.lang.String escapeString(java.lang.String inStr, java.lang.String format, java.util.Map<java.lang.String, java.lang.String> replaceMap)

Escape a string based on format and replace a string based on the replace keyword map.

Parameters:

format - TYPE_HTML, TYPE_JAVA, TYPE_JAVASCIPT, TYPE_JSON, TYPE_SQL, TYPE_XML, TYPE_URL or TYPE_REGEX. The support chain escapes by separating the format into semicolons (;).

replaceMap - A map of keyword and new keyword pair to be replaced before escaping.

 

decryptContent

public static java.lang.String decryptContent(java.lang.String content)

Decrypt all keywords in the content wrapped in SecurityUtil.ENVELOPE with SecurityUtil.decrypt method.

 

encryptContent

public static java.lang.String encryptContent(java.lang.String content)

Encrypt all keywords in the content wrapped in SecurityUtil.ENVELOPE with SecurityUtil.encrypt method.

 

getUrlParams

public static java.util.Map<java.lang.String, java.lang.String[]> getUrlParams(java.lang.String url)

Converts all request parameters in a URL to a map.

 

md5

public static java.lang.String md5(java.lang.String content)

Encrypt the content with MD5.

 

md5Base16

public static java.lang.String md5Base16(java.lang.String content)

Encrypt the content with MD5 base16.

 

searchAndReplaceByteContent

public static byte[] searchAndReplaceByteContent(byte[] bytes, java.lang.String search, java.lang.String replacement)

Search a keyword and replace it with a new keyword in byte content.

 

searchAndReplaceByteContent

public static byte[] searchAndReplaceByteContent(byte[] bytes, java.util.Map<java.lang.String, java.lang.String> replacements)

Search keywords and replace them with the corresponding new keywords in byte content.

 

stripAllHtmlTag

public static java.lang.String stripAllHtmlTag(java.lang.String content)

Remove all HTML tags from the content.

 

stripHtmlRelaxed

public static java.lang.String stripHtmlRelaxed(java.lang.String content)

Remove the script and unknown tag from the content.

 

stripHtmlTag

public static java.lang.String stripHtmlTag(java.lang.String content, java.lang.String[] allowedTag) 

Removed all HTML tags not in the allowed map from the content.

 

validateEmail

public static boolean validateEmail(java.lang.String email, boolean multiple)

The method used to validate an email. Options to validate multiple emails separated by a semicolon (;).

 

Nested Class

IgnoreCaseComparator

public class IgnoreCaseComparator implements java.util.Comparator<java.lang.String>

A comparator to compare string values with letter cases was ignored.

Methods
compare
public int compare(java.lang.String strA, java.lang.String strB)

Compare two strings with letter case ignored.

Created by Damian Last modified by Aadrian on Dec 13, 2024