StringUtil (pdp-cms 5.6.2 API)

java.lang.Object
- com.frameworkset.platform.cms.util.StringUtil

所有已实现的接口:

java.io.Serializable
```
public final class StringUtil
extends java.lang.Object
implements java.io.Serializable
```
Provides String utility functions.

从以下版本开始:

6.0.0

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`BODY_END_REGEX` Regular expression that matches the HTML body end tag.
`static java.lang.String`	`BODY_START_REGEX` Regular expression that matches the HTML body start tag.
`static java.lang.String`	`FALSE` Constant for `"false"`.
`static java.lang.String`	`LINE_SEPARATOR` a convienient shorthand to the line separator constant.
`static java.lang.String`	`MACRO_OPENCMS_CONTEXT` Context macro.
`static java.lang.String`	`TABULATOR` a convienient shorthand for tabulations.
`static java.lang.String`	`TRUE` Constant for `"true"`.

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static java.lang.String`	`changeFileNameSuffixTo(java.lang.String filename, java.lang.String suffix)` Changes the filename suffix.
`static void`	`checkName(java.lang.String name, java.lang.String contraints, java.lang.String key, I_CmsMessageBundle bundle)` Checks if a given name is composed only of the characters `a...z,A...Z,0...9` and the provided `contraints`.
`static java.lang.String`	`escapeHtml(java.lang.String source)` Replaces occurences of special control characters in the given input with a HTML representation.
`static java.lang.String`	`escapeJavaScript(java.lang.String source)` Escapes a String so it may be used in JavaScript String definitions.
`static java.lang.String`	`escapePattern(java.lang.String source)` Escapes a String so it may be used as a Perl5 regular expression.
`static java.util.Map`	`extendAttribute(java.lang.String text, java.lang.String attribute, java.lang.String defValue)` This method takes a part of a html tag definition, an attribute to extend within the given text and a default value for this attribute; and returns a `Map` with 2 values: a `String` with key `"text"` with the new text without the given attribute, and another `String` with key `"value"` with the new extended value for the given attribute, this value is sourrounded by the same type of quotation marks as in the given text.
`static java.lang.String`	`extractHtmlBody(java.lang.String content)` Extracts the content of a <body> tag in a HTML page.
`static java.lang.String`	`extractXmlEncoding(java.lang.String content)` Extracts the xml encoding setting from an xml file that is contained in a String by parsing the xml head.
`static java.lang.String`	`formatResourceName(java.lang.String name, int maxLength)` Formats a resource name that it is displayed with the maximum length and path information is adjusted.
`static java.lang.String`	`formatRuntime(long runtime)` Formats a runtime in the format hh:mm:ss, to be used e.g. in reports.
`static java.awt.Color`	`getColorValue(java.lang.String value, java.awt.Color defaultValue, java.lang.String key)` Returns the color value (`Color`) for the given String value.
`static int`	`getIntValue(java.lang.String value, int defaultValue, java.lang.String key)` Returns the Integer (int) value for the given String value.
`static boolean`	`isEmpty(java.lang.String value)` Returns `true` if the provided String is either `null` or the empty String `""`.
`static boolean`	`isEmptyOrWhitespaceOnly(java.lang.String value)` Returns `true` if the provided String is either `null` or contains only white spaces.
`static boolean`	`isNotEmpty(java.lang.String value)` Returns `true` if the provided String is neither `null` nor the empty String `""`.
`static boolean`	`isNotEmptyOrWhitespaceOnly(java.lang.String value)` Returns `true` if the provided String is neither `null` nor contains only white spaces.
`static boolean`	`isValidJavaClassName(java.lang.String className)` Checks if the given class name is a valid Java class name.
`static java.lang.String`	`padLeft(java.lang.String input, int size)` Applies white space padding to the left of the given String.
`static java.lang.String`	`padRight(java.lang.String input, int size)` Applies white space padding to the right of the given String.
`static java.lang.String[]`	`splitAsArray(java.lang.String source, char delimiter)` Splits a String into substrings along the provided char delimiter and returns the result as an Array of Substrings.
`static java.lang.String[]`	`splitAsArray(java.lang.String source, java.lang.String delimiter)` Splits a String into substrings along the provided String delimiter and returns the result as an Array of Substrings.
`static java.util.List`	`splitAsList(java.lang.String source, char delimiter)` Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.
`static java.util.List`	`splitAsList(java.lang.String source, char delimiter, boolean trim)` Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.
`static java.util.List`	`splitAsList(java.lang.String source, java.lang.String delimiter)` Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
`static java.util.List`	`splitAsList(java.lang.String source, java.lang.String delimiter, boolean trim)` Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
`static java.lang.String`	`substitute(java.lang.String source, java.util.Map substitions)` Replaces a set of `searchString` and `replaceString` pairs, given by the `substitutions` Map parameter.
`static java.lang.String`	`substitute(java.lang.String source, java.lang.String searchString, java.lang.String replaceString)` Substitutes `searchString` in the given source String with `replaceString`.
`static java.lang.String`	`substituteContextPath(java.lang.String htmlContent, java.lang.String context)` Substitutes the OpenCms context path (e.g.
`static java.lang.String`	`substitutePerl(java.lang.String content, java.lang.String searchString, java.lang.String replaceItem, java.lang.String occurences)` Substitutes searchString in content with replaceItem.
`static java.lang.String`	`toUnicodeLiteral(java.lang.String s)` Returns the java String literal for the given String.
`static java.lang.String`	`trimToSize(java.lang.String source, int length)` Returns a substring of string source, which is at most length characters long.
`static boolean`	`validateRegex(java.lang.String value, java.lang.String regex, boolean allowEmpty)` Validates a value against a regular expression.
`static boolean`	`validateResourceName(java.lang.String name)` Checks if the provided name is a valid resource name, that is contains only valid characters.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - BODY_END_REGEX
```
public static final java.lang.String BODY_END_REGEX
```
    Regular expression that matches the HTML body end tag.
    
    另请参阅:
    
    常量字段值
  - BODY_START_REGEX
```
public static final java.lang.String BODY_START_REGEX
```
    Regular expression that matches the HTML body start tag.
    
    另请参阅:
    
    常量字段值
  - FALSE
```
public static final java.lang.String FALSE
```
    Constant for "false".
  - LINE_SEPARATOR
```
public static final java.lang.String LINE_SEPARATOR
```
    a convienient shorthand to the line separator constant.
  - MACRO_OPENCMS_CONTEXT
```
public static final java.lang.String MACRO_OPENCMS_CONTEXT
```
    Context macro.
    
    另请参阅:
    
    常量字段值
  - TABULATOR
```
public static final java.lang.String TABULATOR
```
    a convienient shorthand for tabulations.
    
    另请参阅:
    
    常量字段值
  - TRUE
```
public static final java.lang.String TRUE
```
    Constant for "true".
- 方法详细资料
  - changeFileNameSuffixTo
```
public static java.lang.String changeFileNameSuffixTo(java.lang.String filename,
                                                      java.lang.String suffix)
```
    Changes the filename suffix.
    
    参数:
    
    filename - the filename to be changed
    
    suffix - the new suffix of the file
    
    返回:
    
    the filename with the replaced suffix
  - checkName
```
public static void checkName(java.lang.String name,
                             java.lang.String contraints,
                             java.lang.String key,
                             I_CmsMessageBundle bundle)
                      throws CmsIllegalArgumentException
```
    Checks if a given name is composed only of the characters a...z,A...Z,0...9 and the provided contraints.
    If the check fails, an Exception is generated. The provided bundle and key is used to generate the Exception. 4 parameters are passed to the Exception:
    1. The name
    2. The first illegal character found
    3. The position where the illegal character was found
    4. The contraints
    参数:
    
    name - the name to check
    
    contraints - the additional character contraints
    
    key - the key to use for generating the Exception (if required)
    
    bundle - the bundle to use for generating the Exception (if required)
    
    抛出:
    
    CmsIllegalArgumentException - if the check fails (generated from the given key and bundle)
  - escapeHtml
```
public static java.lang.String escapeHtml(java.lang.String source)
```
    Replaces occurences of special control characters in the given input with a HTML representation.
    This method currrently replaces line breaks to <br/> and special HTML chars like < > & " with their HTML entity representation.
    
    参数:
    
    source - the String to escape
    
    返回:
    
    the escaped String
  - escapeJavaScript
```
public static java.lang.String escapeJavaScript(java.lang.String source)
```
    Escapes a String so it may be used in JavaScript String definitions.
    This method replaces line breaks, quotationmarks and \ characters.
    
    参数:
    
    source - the String to escape
    
    返回:
    
    the escaped String
  - escapePattern
```
public static java.lang.String escapePattern(java.lang.String source)
```
    Escapes a String so it may be used as a Perl5 regular expression.
    This method replaces the following characters in a String:
    {}[]()\$^.*+/
    
    参数:
    
    source - the string to escape
    
    返回:
    
    the escaped string
  - extendAttribute
```
public static java.util.Map extendAttribute(java.lang.String text,
                                            java.lang.String attribute,
                                            java.lang.String defValue)
```
    This method takes a part of a html tag definition, an attribute to extend within the given text and a default value for this attribute; and returns a Map with 2 values: a String with key "text" with the new text without the given attribute, and another String with key "value" with the new extended value for the given attribute, this value is sourrounded by the same type of quotation marks as in the given text.
    
    参数:
    
    text - the text to search in
    
    attribute - the attribute to remove and extend from the text
    
    defValue - a default value for the attribute, should not have any quotation mark
    
    返回:
    
    a map with the new text and the new value for the given attribute
  - extractHtmlBody
```
public static java.lang.String extractHtmlBody(java.lang.String content)
```
    Extracts the content of a <body> tag in a HTML page.
    This method should be pretty robust and work even if the input HTML does not contains a valid body tag.
    
    参数:
    
    content - the content to extract the body from
    
    返回:
    
    the extracted body tag content
  - extractXmlEncoding
```
public static java.lang.String extractXmlEncoding(java.lang.String content)
```
    Extracts the xml encoding setting from an xml file that is contained in a String by parsing the xml head.
    This is useful if you have a byte array that contains a xml String, but you do not know the xml encoding setting. Since the encoding setting in the xml head is usually encoded with standard US-ASCII, you usually just create a String of the byte array without encoding setting, and use this method to find the 'true' encoding. Then create a String of the byte array again, this time using the found encoding.
    This method will return null in case no xml head or encoding information is contained in the input.
    
    参数:
    
    content - the xml content to extract the encoding from
    
    返回:
    
    the extracted encoding, or null if no xml encoding setting was found in the input
  - formatResourceName
```
public static java.lang.String formatResourceName(java.lang.String name,
                                                  int maxLength)
```
    Formats a resource name that it is displayed with the maximum length and path information is adjusted.
    Example: formatResourceName("/myfolder/subfolder/index.html", 21) returns /.../subfolder/index.html.
    
    参数:
    
    name - the resource name to format
    
    maxLength - the maximum length of the resource name (without leading /...)
    
    返回:
    
    the formatted resource name
  - formatRuntime
```
public static java.lang.String formatRuntime(long runtime)
```
    Formats a runtime in the format hh:mm:ss, to be used e.g. in reports.
    If the runtime is greater then 24 hours, the format dd:hh:mm:ss is used.
    
    参数:
    
    runtime - the time to format
    
    返回:
    
    the formatted runtime
  - getColorValue
```
public static java.awt.Color getColorValue(java.lang.String value,
                                           java.awt.Color defaultValue,
                                           java.lang.String key)
```
    Returns the color value (Color) for the given String value.
    All parse errors are caught and the given default value is returned in this case.
    
    参数:
    
    value - the value to parse as color
    
    defaultValue - the default value in case of parsing errors
    
    key - a key to be included in the debug output in case of parse errors
    
    返回:
    
    the int value for the given parameter value String
  - getIntValue
```
public static int getIntValue(java.lang.String value,
                              int defaultValue,
                              java.lang.String key)
```
    Returns the Integer (int) value for the given String value.
    All parse errors are caught and the given default value is returned in this case.
    
    参数:
    
    value - the value to parse as int
    
    defaultValue - the default value in case of parsing errors
    
    key - a key to be included in the debug output in case of parse errors
    
    返回:
    
    the int value for the given parameter value String
  - isEmpty
```
public static boolean isEmpty(java.lang.String value)
```
    Returns true if the provided String is either null or the empty String "".
    
    参数:
    
    value - the value to check
    
    返回:
    
    true, if the provided value is null or the empty String, false otherwise
  - isEmptyOrWhitespaceOnly
```
public static boolean isEmptyOrWhitespaceOnly(java.lang.String value)
```
    Returns true if the provided String is either null or contains only white spaces.
    
    参数:
    
    value - the value to check
    
    返回:
    
    true, if the provided value is null or contains only white spaces, false otherwise
  - isNotEmpty
```
public static boolean isNotEmpty(java.lang.String value)
```
    Returns true if the provided String is neither null nor the empty String "".
    
    参数:
    
    value - the value to check
    
    返回:
    
    true, if the provided value is not null and not the empty String, false otherwise
  - isNotEmptyOrWhitespaceOnly
```
public static boolean isNotEmptyOrWhitespaceOnly(java.lang.String value)
```
    Returns true if the provided String is neither null nor contains only white spaces.
    
    参数:
    
    value - the value to check
    
    返回:
    
    true, if the provided value is null or contains only white spaces, false otherwise
  - isValidJavaClassName
```
public static boolean isValidJavaClassName(java.lang.String className)
```
    Checks if the given class name is a valid Java class name.
    
    参数:
    
    className - the name to check
    
    返回:
    
    true if the given class name is a valid Java class name
  - padLeft
```
public static java.lang.String padLeft(java.lang.String input,
                                       int size)
```
    Applies white space padding to the left of the given String.
    
    参数:
    
    input - the input to pad left
    
    size - the size of the padding
    
    返回:
    
    the input padded to the left
  - padRight
```
public static java.lang.String padRight(java.lang.String input,
                                        int size)
```
    Applies white space padding to the right of the given String.
    
    参数:
    
    input - the input to pad right
    
    size - the size of the padding
    
    返回:
    
    the input padded to the right
  - splitAsArray
```
public static java.lang.String[] splitAsArray(java.lang.String source,
                                              char delimiter)
```
    Splits a String into substrings along the provided char delimiter and returns the result as an Array of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    返回:
    
    the Array of splitted Substrings
  - splitAsArray
```
public static java.lang.String[] splitAsArray(java.lang.String source,
                                              java.lang.String delimiter)
```
    Splits a String into substrings along the provided String delimiter and returns the result as an Array of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    返回:
    
    the Array of splitted Substrings
  - splitAsList
```
public static java.util.List splitAsList(java.lang.String source,
                                         char delimiter)
```
    Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    返回:
    
    the List of splitted Substrings
  - splitAsList
```
public static java.util.List splitAsList(java.lang.String source,
                                         char delimiter,
                                         boolean trim)
```
    Splits a String into substrings along the provided char delimiter and returns the result as a List of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    trim - flag to indicate if leading and trailing whitespaces should be omitted
    
    返回:
    
    the List of splitted Substrings
  - splitAsList
```
public static java.util.List splitAsList(java.lang.String source,
                                         java.lang.String delimiter)
```
    Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    返回:
    
    the Array of splitted Substrings
  - splitAsList
```
public static java.util.List splitAsList(java.lang.String source,
                                         java.lang.String delimiter,
                                         boolean trim)
```
    Splits a String into substrings along the provided String delimiter and returns the result as List of Substrings.
    
    参数:
    
    source - the String to split
    
    delimiter - the delimiter to split at
    
    trim - flag to indicate if leading and trailing whitespaces should be omitted
    
    返回:
    
    the Array of splitted Substrings
  - substitute
```
public static java.lang.String substitute(java.lang.String source,
                                          java.util.Map substitions)
```
    Replaces a set of searchString and replaceString pairs, given by the substitutions Map parameter.
    
    参数:
    
    source - the constent which is scanned
    
    substitions - the map of substitutions
    
    返回:
    
    the substituted String
    
    另请参阅:
    
    substitute(String, String, String)
  - substitute
```
public static java.lang.String substitute(java.lang.String source,
                                          java.lang.String searchString,
                                          java.lang.String replaceString)
```
    Substitutes searchString in the given source String with replaceString.
    This is a high-performance implementation which should be used as a replacement for String.replaceAll(java.lang.String, java.lang.String) in case no regular expression evaluation is required.
    
    参数:
    
    source - the content which is scanned
    
    searchString - the String which is searched in content
    
    replaceString - the String which replaces searchString
    
    返回:
    
    the substituted String
  - substituteContextPath
```
public static java.lang.String substituteContextPath(java.lang.String htmlContent,
                                                     java.lang.String context)
```
    Substitutes the OpenCms context path (e.g. /opencms/opencms/) in a HTML page with a special variable so that the content also runs if the context path of the server changes.
    
    参数:
    
    htmlContent - the HTML to replace the context path in
    
    context - the context path of the server
    
    返回:
    
    the HTML with the replaced context path
  - substitutePerl
```
public static java.lang.String substitutePerl(java.lang.String content,
                                              java.lang.String searchString,
                                              java.lang.String replaceItem,
                                              java.lang.String occurences)
```
    Substitutes searchString in content with replaceItem.
    
    参数:
    
    content - the content which is scanned
    
    searchString - the String which is searched in content
    
    replaceItem - the new String which replaces searchString
    
    occurences - must be a "g" if all occurences of searchString shall be replaced
    
    返回:
    
    String the substituted String
  - toUnicodeLiteral
```
public static java.lang.String toUnicodeLiteral(java.lang.String s)
```
    Returns the java String literal for the given String.
    This is the form of the String that had to be written into sourcecode using the unicode escape sequence for special characters.
    Example: "?" would be transformed to "\\u00C4".
    
    参数:
    
    s - a string that may contain non-ascii characters
    
    返回:
    
    the java unicode escaped string Literal of the given input string
  - trimToSize
```
public static java.lang.String trimToSize(java.lang.String source,
                                          int length)
```
    Returns a substring of string source, which is at most length characters long.
    
    参数:
    
    source - the string to trim
    
    length - the maximum length of the string to be returned
    
    返回:
    
    a substring of string source, which is at most length characters long
  - validateRegex
```
public static boolean validateRegex(java.lang.String value,
                                    java.lang.String regex,
                                    boolean allowEmpty)
```
    Validates a value against a regular expression.
    
    参数:
    
    value - the value to test
    
    regex - the regular expression
    
    allowEmpty - if an empty value is allowed
    
    返回:
    
    true if the value satisfies the validation
  - validateResourceName
```
public static boolean validateResourceName(java.lang.String name)
```
    Checks if the provided name is a valid resource name, that is contains only valid characters.
    PLEASE NOTE: This logic is NOT yet used in the current release.
    
    参数:
    
    name - the resource name to check
    
    返回:
    
    true if the resource name is vaild, false otherwise

类 StringUtil

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

BODY_END_REGEX

BODY_START_REGEX

FALSE

LINE_SEPARATOR

MACRO_OPENCMS_CONTEXT

TABULATOR

TRUE

方法详细资料

changeFileNameSuffixTo

checkName

escapeHtml

escapeJavaScript

escapePattern

extendAttribute

extractHtmlBody

extractXmlEncoding

formatResourceName

formatRuntime

getColorValue

getIntValue

isEmpty

isEmptyOrWhitespaceOnly

isNotEmpty

isNotEmptyOrWhitespaceOnly

isValidJavaClassName

padLeft

padRight

splitAsArray

splitAsArray

splitAsList

splitAsList

splitAsList

splitAsList

substitute

substitute

substituteContextPath

substitutePerl

toUnicodeLiteral

trimToSize

validateRegex

validateResourceName