StringUtil (RapidContext 0.16 Java API)

java.lang.Object
- org.rapidcontext.util.StringUtil

```
public class StringUtil
extends java.lang.Object
```
A set of utility methods for handling strings and characters.

Version:

1.0

Author:

Per Cederberg

Constructor Summary

Constructors
Constructor and Description

StringUtil()

Constructors
Constructor and Description
`StringUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`escapeProperty(char chr)` Returns an escaped property file value for the specified input character.
`static java.lang.String`	`escapeProperty(java.lang.String str)` Returns an escaped property file value for the specified input string.
`static java.lang.String`	`escapeXml(char chr)` Returns properly escaped XML for the specified input character.
`static java.lang.String`	`escapeXml(java.lang.String str)` Returns properly escaped XML for the specified input string.
`static java.lang.String`	`first(java.lang.String str1, java.lang.String str2, java.lang.String str3)` Returns the first non-empty value of the argument strings.
`static boolean`	`isAscii(char c)` Checks if a character belongs to the printable ASCII set.
`static boolean`	`isAscii(java.lang.String str)` Checks if all characters in a string belongs to the printable ASCII set.
`static boolean`	`isIsoLatin1(char c)` Checks if a character belongs to the printable ISO-8859-1 set.
`static boolean`	`isIsoLatin1(java.lang.String str)` Checks if all characters in a string belongs to the printable ISO-8859-1 set.
`static boolean`	`isNumber(char c)` Checks if a character is a numeric ASCII character.
`static boolean`	`isNumber(java.lang.String str)` Checks if all characters in a string are numeric ASCII characters.
`static java.lang.String`	`match(java.lang.String str, java.util.regex.Pattern re)` Returns the first match of a regular expression from a string.
`static java.lang.String`	`toHex(char chr)` Returns a 4 digit hexadecimal representation of a character.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringUtil
```
public StringUtil()
```
- Method Detail
  - isAscii
```
public static boolean isAscii(char c)
```
    Checks if a character belongs to the printable ASCII set. Any character code between 32 and 126 is considered inside this set.
    
    Parameters:
    
    c - the character to check
    
    Returns:
    
    true if the character is printable ASCII, or false otherwise
  - isAscii
```
public static boolean isAscii(java.lang.String str)
```
    Checks if all characters in a string belongs to the printable ASCII set. Any character code between 32 and 126 is considered inside this set.
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if the string is printable ASCII, or false otherwise
  - isIsoLatin1
```
public static boolean isIsoLatin1(char c)
```
    Checks if a character belongs to the printable ISO-8859-1 set. Any character in the printable ASCII set or with a character code between 160 and 255 in considered inside this set.
    
    Parameters:
    
    c - the character to check
    
    Returns:
    
    true if the character is printable ISO-8859-1, or false otherwise
  - isIsoLatin1
```
public static boolean isIsoLatin1(java.lang.String str)
```
    Checks if all characters in a string belongs to the printable ISO-8859-1 set. Any character in the printable ASCII set or with a character code between 160 and 255 in considered inside this set.
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if the string is printable ISO-8859-1, or false otherwise
  - isNumber
```
public static boolean isNumber(char c)
```
    Checks if a character is a numeric ASCII character.
    
    Parameters:
    
    c - the character to check
    
    Returns:
    
    true if the character is a number, or false otherwise
  - isNumber
```
public static boolean isNumber(java.lang.String str)
```
    Checks if all characters in a string are numeric ASCII characters. The string must also be at least one character long and no whitespace characters are accepted.
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if the string is numeric, or false otherwise
  - toHex
```
public static java.lang.String toHex(char chr)
```
    Returns a 4 digit hexadecimal representation of a character.
    
    Parameters:
    
    chr - the character to convert
    
    Returns:
    
    the hexadecimal character code
  - escapeProperty
```
public static java.lang.String escapeProperty(char chr)
```
    Returns an escaped property file value for the specified input character. This method will return character escapes for backslash, tab and newline. It will also return a Unicode escape for any non-ASCII character.
    
    Parameters:
    
    chr - the character to convert
    
    Returns:
    
    the valid property text string
  - escapeProperty
```
public static java.lang.String escapeProperty(java.lang.String str)
```
    Returns an escaped property file value for the specified input string. This method will return character escapes for backslash, tab and newline. It will also return a Unicode escape for any non-ASCII character.
    
    Parameters:
    
    str - the string to convert
    
    Returns:
    
    the valid property text string
  - escapeXml
```
public static java.lang.String escapeXml(char chr)
```
    Returns properly escaped XML for the specified input character. This method will return an XML character entities for all non-ASCII characters as well as the reserved XML characters.
    
    Parameters:
    
    chr - the character to convert
    
    Returns:
    
    the valid XML string
  - escapeXml
```
public static java.lang.String escapeXml(java.lang.String str)
```
    Returns properly escaped XML for the specified input string. This method will add XML character entities for all non-ASCII characters as well as the reserved XML characters.
    
    Parameters:
    
    str - the string to convert
    
    Returns:
    
    the valid XML string
  - first
```
public static java.lang.String first(java.lang.String str1,
                                     java.lang.String str2,
                                     java.lang.String str3)
```
    Returns the first non-empty value of the argument strings.
    
    Parameters:
    
    str1 - the first string to check
    
    str2 - the second string to check
    
    str3 - the third string to check
    
    Returns:
    
    the first non-empty value of the argument strings, or the last string value
  - match
```
public static java.lang.String match(java.lang.String str,
                                     java.util.regex.Pattern re)
```
    Returns the first match of a regular expression from a string.
    
    Parameters:
    
    str - the string to match
    
    re - the compiled regular expression
    
    Returns:
    
    the matched substring, or null if no match was found

Class StringUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringUtil

Method Detail

isAscii

isAscii

isIsoLatin1

isIsoLatin1

isNumber

isNumber

toHex

escapeProperty

escapeProperty

escapeXml

escapeXml

first

match