BasicStringHelper (Tentackle Common 2.0.4 API)

java.lang.Object
- org.tentackle.common.BasicStringHelper

```
public final class BasicStringHelper
extends Object
```
Provides Methods to format names of methods and variables.

Author:

harald

Field Summary

Fields
Modifier and Type Field and Description

static String[] javaReservedWords
All java reserved words.

Fields
Modifier and Type	Field and Description
`static String[]`	`javaReservedWords` All java reserved words.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`digitToString(Character digit)` Gets the word-string for a digit. Example:
`static String`	`firstToLower(String str)` Converts the first character of string to uppercase.
`static String`	`firstToUpper(String str)` Converts the first character of string to uppercase.
`static String`	`getContinuedLine(String line)` Checks whether given string introduces a continuation line.
`static String`	`getPlainClassName(String className)` Gets a classname without any optional generics.
`static boolean`	`isAllWhitespace(String str)` Checks if string contains only whitespaces.
`static boolean`	`isReservedWord(String word)` Returns whether given string is a reserved java keyword.
`static boolean`	`isValidJavaClassName(String className)` Checks that given string is a valid Java classname. Both classnames with a full classpath or without are validated.
`static boolean`	`isValidJavaIdentifier(String str)` Returns whether the given string is a valid java identifier.
`static boolean`	`isValidJavaPackageName(String packageName)` Checks that given string is a valid Java packagename. This is very restrictive verification.
`static String`	`parseString(String str)` Parses a string. The string may be enclosed in double- or single quotes which will be removed.
`static String`	`readTextFromResource(String resourceName)` Reads a textfile from a resource. The textfile must be in the classpath.
`static List<String>`	`split(String str, String delimiters)` Splits a string keeping strings together. The strings may be enclosed in double- or single quotes which will not be removed.
`static String`	`toDoubleQuotes(String str)` Takes a string, surrounds it with double-quotes and escapes all double-quotes already in the string according to Unix rules.
`static String`	`toLower(String str)` Converts a string to lowercase allowing null values.
`static String`	`toUpper(String str)` Converts a string to uppercase allowing null values.

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

- Field Detail
  - javaReservedWords
```
public static final String[] javaReservedWords
```
    All java reserved words.
- Method Detail
  - toUpper
```
public static String toUpper(String str)
```
    Converts a string to uppercase allowing null values.
    
    Parameters:
    
    str - the string
    
    Returns:
    
    the uppercase string or null
  - toLower
```
public static String toLower(String str)
```
    Converts a string to lowercase allowing null values.
    
    Parameters:
    
    str - the string
    
    Returns:
    
    the lowercase string or null
  - firstToUpper
```
public static String firstToUpper(String str)
```
    Converts the first character of string to uppercase.
    
    Parameters:
    
    str - the string
    
    Returns:
    
    the converted string
  - firstToLower
```
public static String firstToLower(String str)
```
    Converts the first character of string to uppercase.
    
    Parameters:
    
    str - the string
    
    Returns:
    
    the converted string
  - getPlainClassName
```
public static String getPlainClassName(String className)
```
    Gets a classname without any optional generics.
    
    Parameters:
    
    className - the original classname
    
    Returns:
    
    classname without generics
  - getContinuedLine
```
public static String getContinuedLine(String line)
```
    Checks whether given string introduces a continuation line.
    This is the case if the last character is an unquoted backslash.
    
    Parameters:
    
    line - the source line
    
    Returns:
    
    null if line does not introduce a continuation line
  - toDoubleQuotes
```
public static String toDoubleQuotes(String str)
```
    Takes a string, surrounds it with double-quotes and escapes all double-quotes already in the string according to Unix rules. Example:
```
 Length 5" --> "Length 5\""
 
```
    Parameters:
    
    str - the string
    
    Returns:
    
    the string in double quotes
  - parseString
```
public static String parseString(String str)
```
    Parses a string.
    The string may be enclosed in double- or single quotes which will be removed. Those special characters may be escaped by a backslash. The backslash itself can be written as a double backslash. Special escapes are:
    \n = new line \r = carriage return \t = tab \f = form feed
    
    Parameters:
    
    str - the source string
    
    Returns:
    
    a string, never null
  - split
```
public static List<String> split(String str,
                                 String delimiters)
```
    Splits a string keeping strings together.
    The strings may be enclosed in double- or single quotes which will not be removed. Those special characters may be escaped by a backslash. The backslash itself can be written as a double backslash. Special escapes are:
    \n = new line \r = carriage return \t = tab \f = form feed
    
    Parameters:
    
    str - the string
    
    delimiters - the delimiter characters
    
    Returns:
    
    the strings, never null
  - isValidJavaClassName
```
public static boolean isValidJavaClassName(String className)
```
    Checks that given string is a valid Java classname.
    Both classnames with a full classpath or without are validated.
    
    Parameters:
    
    className - the classname
    
    Returns:
    
    true if valid
  - isValidJavaPackageName
```
public static boolean isValidJavaPackageName(String packageName)
```
    Checks that given string is a valid Java packagename.
    This is very restrictive verification. Packagenames must be all lowercase alphabetic or digits and must contain only dots and underscores.
    
    Parameters:
    
    packageName - the packagename
    
    Returns:
    
    true if valid
  - isValidJavaIdentifier
```
public static boolean isValidJavaIdentifier(String str)
```
    Returns whether the given string is a valid java identifier.
    
    Parameters:
    
    str - the string
    
    Returns:
    
    true if valid, false if not
  - readTextFromResource
```
public static String readTextFromResource(String resourceName)
                                   throws IOException
```
    Reads a textfile from a resource.
    The textfile must be in the classpath.
    Example:
```
   String model = BasicStringHelper.readTestFromResource("org/tentackle/model/TestModel.txt");
 
```
    Parameters:
    
    resourceName - the name of the resource
    
    Returns:
    
    the loaded text
    
    Throws:
    
    IOException - if loading failed or no such resource
  - isAllWhitespace
```
public static boolean isAllWhitespace(String str)
```
    Checks if string contains only whitespaces.
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if null, empty or all whitespace, false if at least one non-whitespace-character found
  - isReservedWord
```
public static boolean isReservedWord(String word)
```
    Returns whether given string is a reserved java keyword.
    
    Parameters:
    
    word - the string to test
    
    Returns:
    
    true if java reserved word
  - digitToString
```
public static String digitToString(Character digit)
```
    Gets the word-string for a digit.
    Example:
```
 '0' --> "zero"
 
```
    Parameters:
    
    digit - the digit character
    
    Returns:
    
    the word-string

Class BasicStringHelper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

javaReservedWords

Method Detail

toUpper

toLower

firstToUpper

firstToLower

getPlainClassName

getContinuedLine

toDoubleQuotes

parseString

split

isValidJavaClassName

isValidJavaPackageName

isValidJavaIdentifier

readTextFromResource

isAllWhitespace

isReservedWord

digitToString