Strings (ZenGarden-Core 0.1.12 API)

java.lang.Object
- org.openzen.zengarden.util.Strings

public class Strings
extends java.lang.Object

Contains utility functions for Strings.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Strings.CharacterEntity

Nested Classes
Modifier and Type	Class and Description
`static class`	`Strings.CharacterEntity`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`capitalizeFirstLetter(java.lang.String value)` Capitalizes the first letter of the given string.
`static java.lang.String`	`escape(java.lang.String value, char quote, boolean escapeUnicode)` Escapes special characters in the given string, including ".
`static java.lang.String`	`fillTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.String> values)`
`static int`	`getCommonPrefixLength(java.lang.String a, java.lang.String b)` Determines the length of the common string prefix; that is, the longest value of L for which a.substring(0, L) == b.substring(0, L).
`static int`	`getCommonSuffixLength(java.lang.String a, java.lang.String b)` Determines the length of the common string suffix; that is, the longest value of L for which a.substring(a.length - L, a.length) == b.substring( b.length - L, b.length).
`static java.util.Collection<Strings.CharacterEntity>`	`getNamedCharacterEntities()` Retrieves all official named character entities.
`static java.lang.String`	`join(java.lang.String separator, java.lang.Iterable<java.lang.String> values)` Joins the given strings with the given separator.
`static java.lang.String`	`join(java.lang.String separator, java.lang.String... values)` Joins the given strings with the given separator.
`static java.lang.String`	`lpad(java.lang.String value, int length, char c)` Left pads (prefixes) a string with characters until it reaches the given string length.
`static Strings.CharacterEntity`	`readCharacterEntity(java.lang.String str, int offset)` Reads a single character entity (formatted as &characterEntity;) at the given string offset.
`static int`	`readHexCharacter(char hex)` Reads a single hex digit and converts it to a value 0-15.
`static java.lang.String`	`rpad(java.lang.String value, int length, char c)` Right pads (suffixes) a string with characters until it reaches the given string length.
`static byte[]`	`sha256Hash(java.lang.String value)` Creates a sha256 hash of the given string, using UTF-8 encoding.
`static java.lang.String[]`	`split(java.lang.String value, char delimiter)` Splits a string in parts, given a specified delimiter.
`static java.lang.String[]`	`split(java.lang.String value, char delimiter, int max)` Splits a string in parts, given a specified delimiter.
`static java.lang.String`	`stripAccents(java.lang.String str)` Strips all accents (and alike) from the given string.
`static StringTemplate`	`template(java.lang.String template)` Starts a string template.
`static java.lang.String`	`times(char c, int count)` Constructs a string with count times the given character.
`static java.lang.String`	`unescape(java.lang.String escapedString)` Unescapes a string escaped in one of following ways: A string escaped with single quotes (`'Hello "my" world'`) A string escaped with double quotes (`"Hello 'my' world"`) A near-literal string (`@"C:\Program Files\"`) in which escape sequences aren't processed but the " character cannot occur The following escape sequences are recognized: \\ \' \" \&namedCharacterEntity; (note that although redundant, \&#ddd; and \&#xXXXX; are also allowed) \t \n \r \b \f \&uXXXX for unicode character points

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

- Method Detail
  - sha256Hash
```
public static byte[] sha256Hash(java.lang.String value)
```
    Creates a sha256 hash of the given string, using UTF-8 encoding.
    
    Parameters:
    
    value - string value
    
    Returns:
    
    hash
  - stripAccents
```
public static java.lang.String stripAccents(java.lang.String str)
```
    Strips all accents (and alike) from the given string.
    
    Parameters:
    
    str - original string
    
    Returns:
    
    stripped string
  - join
```
public static java.lang.String join(java.lang.String separator,
                                    java.lang.String... values)
```
    Joins the given strings with the given separator.
    
    Parameters:
    
    separator - separator
    
    values - string values
    
    Returns:
    
    joined string
  - join
```
public static java.lang.String join(java.lang.String separator,
                                    java.lang.Iterable<java.lang.String> values)
```
    Joins the given strings with the given separator.
    
    Parameters:
    
    separator - separator
    
    values - string values
    
    Returns:
    
    joined string
  - split
```
public static java.lang.String[] split(java.lang.String value,
                                       char delimiter)
```
    Splits a string in parts, given a specified delimiter.
    
    Parameters:
    
    value - string to be split
    
    delimiter - delimiter
    
    Returns:
    
    split string
  - split
```
public static java.lang.String[] split(java.lang.String value,
                                       char delimiter,
                                       int max)
```
    Splits a string in parts, given a specified delimiter.
    
    Parameters:
    
    value - string to be split
    
    delimiter - delimiter
    
    max - maximum number of substrings
    
    Returns:
    
    split string
  - capitalizeFirstLetter
```
public static java.lang.String capitalizeFirstLetter(java.lang.String value)
```
    Capitalizes the first letter of the given string.
    
    Parameters:
    
    value - original string
    
    Returns:
    
    modified string
  - getCommonPrefixLength
```
public static int getCommonPrefixLength(java.lang.String a,
                                        java.lang.String b)
```
    Determines the length of the common string prefix; that is, the longest value of L for which a.substring(0, L) == b.substring(0, L).
    
    Parameters:
    
    a - first string
    
    b - second string
    
    Returns:
    
    common prefix length
  - getCommonSuffixLength
```
public static int getCommonSuffixLength(java.lang.String a,
                                        java.lang.String b)
```
    Determines the length of the common string suffix; that is, the longest value of L for which a.substring(a.length - L, a.length) == b.substring( b.length - L, b.length).
    
    Parameters:
    
    a - first string
    
    b - second string
    
    Returns:
    
    common prefix length
  - lpad
```
public static java.lang.String lpad(java.lang.String value,
                                    int length,
                                    char c)
```
    Left pads (prefixes) a string with characters until it reaches the given string length. Does not do anything if the string length >= given length.
    
    Parameters:
    
    value - value to be padded
    
    length - desired string length
    
    c - padding character
    
    Returns:
    
    padded string
  - rpad
```
public static java.lang.String rpad(java.lang.String value,
                                    int length,
                                    char c)
```
    Right pads (suffixes) a string with characters until it reaches the given string length. Does not do anything if the string length >= given length.
    
    Parameters:
    
    value - value to be padded
    
    length - desired string length
    
    c - padding character
    
    Returns:
    
    padded string
  - fillTemplate
```
public static java.lang.String fillTemplate(java.lang.String template,
                                            java.util.Map<java.lang.String,java.lang.String> values)
```
  - template
```
public static StringTemplate template(java.lang.String template)
```
    Starts a string template. Can be used as a more fluid alternative to the above in cases where the parameters are known.
    
    Parameters:
    
    template - template string
    
    Returns:
    
    template builder
  - times
```
public static java.lang.String times(char c,
                                     int count)
```
    Constructs a string with count times the given character.
    
    Parameters:
    
    c - filling character
    
    count - character count
    
    Returns:
    
    string value
  - unescape
```
public static java.lang.String unescape(java.lang.String escapedString)
```
    Unescapes a string escaped in one of following ways:
    - A string escaped with single quotes ('Hello "my" world')
    - A string escaped with double quotes ("Hello 'my' world")
    - A near-literal string (@"C:\Program Files\") in which escape sequences aren't processed but the " character cannot occur
    The following escape sequences are recognized:
    - \\
    - \'
    - \"
    - \&namedCharacterEntity; (note that although redundant, \&#ddd; and \&#xXXXX; are also allowed)
    - \t
    - \n
    - \r
    - \b
    - \f
    - \&uXXXX for unicode character points
    Parameters:
    
    escapedString - escaped string
    
    Returns:
    
    unescaped string
  - escape
```
public static java.lang.String escape(java.lang.String value,
                                      char quote,
                                      boolean escapeUnicode)
```
    Escapes special characters in the given string, including ". (but not '). Adds opening and closing quotes.
    
    Parameters:
    
    value - value to be escaped
    
    quote - character (' or ")
    
    escapeUnicode - true to escape any non-ascii value, false to leave them be
    
    Returns:
    
    escaped value
  - readHexCharacter
```
public static int readHexCharacter(char hex)
```
    Reads a single hex digit and converts it to a value 0-15.
    
    Parameters:
    
    hex - hex digit
    
    Returns:
    
    converted value
  - getNamedCharacterEntities
```
public static java.util.Collection<Strings.CharacterEntity> getNamedCharacterEntities()
```
    Retrieves all official named character entities.
    
    Returns:
    
    named character entities
  - readCharacterEntity
```
public static Strings.CharacterEntity readCharacterEntity(java.lang.String str,
                                                          int offset)
```
    Reads a single character entity (formatted as &characterEntity;) at the given string offset. The following formats are supported:
    - &namedCharacterEntity;
    - &#ddd
    - &#xXXXX
    The returned value includes the character entity, without the enclosing & and ; characters.
    Parameters:
    
    str - string value to search in
    
    offset - offset to look at
    
    Returns:
    
    character entity
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given string does not contain a valid character entity at the given position

Class Strings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sha256Hash

stripAccents

join

join

split

split

capitalizeFirstLetter

getCommonPrefixLength

getCommonSuffixLength

lpad

rpad

fillTemplate

template

times

unescape

escape

readHexCharacter

getNamedCharacterEntities

readCharacterEntity