StringUtil (ObjectLab Kit 1.4.8 API)

java.lang.Object
- net.objectlab.kit.util.StringUtil

public final class StringUtil
extends Object

Author:: Benoit Xhenseval

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLOSE_PARENTHESES`
`static String`	`COMMA`
`static String`	`DOT`
`static String`	`EMPTY`
`static String`	`NEW_LINE`
`static String`	`NULL_COL`
`static String`	`OPEN_PARENTHESES`
`static String`	`SINGLE_QUOTE`
`static String`	`SLASH`
`static String`	`SPACE`
`static org.apache.commons.lang3.builder.StandardToStringStyle`	`STYLE`
`static String`	`WILDCARD`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`allEquals(String value, String... strings)` Return true if all strings are the same.
`static boolean`	`anyEmpty(String... strings)`
`static String`	`asList(String[] values, String separator)`
`static String`	`boxify(char boxing, String text)` Returns a String which is surrounded by a box made of boxing char.
`static int`	`compareTo(String s1, String s2)` Handle null.
`static String`	`concat(Object... osToString)` Concatenate the string value of the objects (toString()).
`static String`	`concatWithSpaces(Object... osToString)` Concatenate the string value of the objects (toString()) and insert a space between each value.
`static String`	`defaultFileFormatTimestamp(Date date)`
`static String`	`defaultFormatDatetime(Date date)`
`static String`	`emptyIfNull(Object obj)` Deprecated. use toStringOrEmpty
`static boolean`	`equalsAnyIgnoreCase(String val, String... strings)`
`static boolean`	`equalsAnyIgnoreCase(String val, String toCheck)`
`static boolean`	`equalsIgnoreCaseOrValueIsWildcard(String value, String toCheck)` Does equalsIgnoreCase call but if the value is '*', immediately returns true.
`static String`	`firstCharToUpper(String txt)`
`static boolean`	`ifNotBlank(String text, Consumer<String> consumer)` If the string is not blank call the consumer (depends on JDK8+)
`static boolean`	`isNotBlank(Object text)`
`static boolean`	`isWildcardOrNull(String txt)`
`static boolean`	`noneBlank(String... text)`
`static String`	`nullIfEmpty(String txt)` return null if txt is null or empty
`static String`	`prepareForNumericParsing(String inputStr)` Remove " and spaces from the input string.
`static String`	`processCaseTreatment(String str, CaseTreatment caseTreatment)`
`static String`	`removeTrailingChar(String original, char charToRemove)`
`static String`	`replace(String originalPattern, String newPattern, String originalString)`
`static String`	`replaceCRToken(String original)` Replaces any %CR% tokens with the newline character.
`static String`	`replaceToken(String original, String token, Object replacement)`
`static String`	`replaceToken(String original, String token, String replacement)` Replaces the token, surrounded by % within a string with new value.
`static String`	`returnIfNotNull(String txt, String defaultTxt)`
`static String`	`singleQuote(String text)` Add single quotes ' around the text.
`static String`	`toLowerCase(String str)`
`static String`	`toString(Object object)`
`static String`	`toStringOrEmpty(Object object)`
`static String`	`toUpperCase(String str)`
`static String`	`trim(String str)` Handles null.
`static String`	`trimAndUpperCase(String str)`
`static String`	`wrapText(String inString, String newline, int wrapColumn)` Takes a block of text which might have long lines in it and wraps the long lines based on the supplied wrapColumn parameter.

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

Field Detail

NEW_LINE
```
public static final String NEW_LINE
```

SINGLE_QUOTE

public static final String SINGLE_QUOTE

See Also:: Constant Field Values

SLASH
```
public static final String SLASH
```
See Also:

Constant Field Values

NULL_COL
```
public static final String NULL_COL
```
See Also:

Constant Field Values

COMMA
```
public static final String COMMA
```
See Also:

Constant Field Values

DOT
```
public static final String DOT
```
See Also:

Constant Field Values

SPACE
```
public static final String SPACE
```
See Also:

Constant Field Values

EMPTY
```
public static final String EMPTY
```
See Also:

Constant Field Values

WILDCARD
```
public static final String WILDCARD
```
See Also:

Constant Field Values

STYLE

public static final org.apache.commons.lang3.builder.StandardToStringStyle STYLE

OPEN_PARENTHESES

public static final String OPEN_PARENTHESES

See Also:: Constant Field Values

CLOSE_PARENTHESES

public static final String CLOSE_PARENTHESES

See Also:: Constant Field Values

Method Detail

removeTrailingChar

public static String removeTrailingChar(String original,
                                        char charToRemove)

defaultFormatDatetime

public static String defaultFormatDatetime(Date date)

defaultFileFormatTimestamp

public static String defaultFileFormatTimestamp(Date date)

replaceToken

public static String replaceToken(String original,
                                  String token,
                                  Object replacement)

replace

public static String replace(String originalPattern,
                             String newPattern,
                             String originalString)

replaceToken
```
public static String replaceToken(String original,
                                  String token,
                                  String replacement)
```
Replaces the token, surrounded by % within a string with new value. Also replaces any %CR% tokens with the newline character.

Returns:

the original string with the %token% (if it exists) replaced with the replacement string. If original or %token% are null, then returns the original string.

replaceCRToken
```
public static String replaceCRToken(String original)
```
Replaces any %CR% tokens with the newline character.

Returns:

the original string with the '%CR%' tokens (if it exists) replaced with the new line character.

wrapText
```
public static String wrapText(String inString,
                              String newline,
                              int wrapColumn)
```
Takes a block of text which might have long lines in it and wraps the long lines based on the supplied wrapColumn parameter. It was initially implemented for use by VelocityEmail. If there are tabs in inString, you are going to get results that are a bit strange, since tabs are a single character but are displayed as 4 or 8 spaces. Remove the tabs.

Parameters:

inString - Text which is in need of word-wrapping.

newline - The characters that define a newline.

wrapColumn - The column to wrap the words at.

Returns:

The text with all the long lines word-wrapped.

trimAndUpperCase

public static String trimAndUpperCase(String str)

toLowerCase

public static String toLowerCase(String str)

toUpperCase

public static String toUpperCase(String str)

processCaseTreatment

public static String processCaseTreatment(String str,
                                          CaseTreatment caseTreatment)

toString
```
public static String toString(Object object)
```
Returns:

object.toString if object != null; otherwise returns null;

toStringOrEmpty
```
public static String toStringOrEmpty(Object object)
```
Returns:

object.toString if object != null; otherwise returns "";

singleQuote
```
public static String singleQuote(String text)
```
Add single quotes ' around the text.

Parameters:

text -

Returns:

'text'

isNotBlank

public static boolean isNotBlank(Object text)

ifNotBlank

public static boolean ifNotBlank(String text,
                                 Consumer<String> consumer)

If the string is not blank call the consumer (depends on JDK8+)

Parameters:: text -; consumer -
Returns:: true if consumed
Since:: 1.4.0

noneBlank

public static boolean noneBlank(String... text)

allEquals

public static boolean allEquals(String value,
                                String... strings)

Return true if all strings are the same.

equalsAnyIgnoreCase

public static boolean equalsAnyIgnoreCase(String val,
                                          String... strings)

Parameters:: val - string to look for; strings - possibilities
Returns:: true if any of strs is equals to val (ignoring case).

equalsAnyIgnoreCase

public static boolean equalsAnyIgnoreCase(String val,
                                          String toCheck)

Parameters:: val - string to look for; toCheck - string to check
Returns:: true if val is equals to '*' or toCheck.

concat
```
public static String concat(Object... osToString)
```
Concatenate the string value of the objects (toString()). If osString is null, return empty "" but if one of the value is null, then use 'null' string.

concatWithSpaces
```
public static String concatWithSpaces(Object... osToString)
```
Concatenate the string value of the objects (toString()) and insert a space between each value. If osString is null, return empty "" but if one of the value is null, then use 'null' string.

emptyIfNull
```
@Deprecated
public static String emptyIfNull(Object obj)
```
Deprecated. use toStringOrEmpty

Returns "" if obj is null, obj.toString() otherwise.

Parameters:

obj -

isWildcardOrNull

public static boolean isWildcardOrNull(String txt)

returnIfNotNull

public static String returnIfNotNull(String txt,
                                     String defaultTxt)

firstCharToUpper

public static String firstCharToUpper(String txt)

trim

public static String trim(String str)

Handles null.

prepareForNumericParsing
```
public static String prepareForNumericParsing(String inputStr)
```
Remove " and spaces from the input string.

Parameters:

inputStr -

Returns:

if null, return empty

nullIfEmpty
```
public static String nullIfEmpty(String txt)
```
return null if txt is null or empty

Parameters:

txt -

compareTo

public static int compareTo(String s1,
                            String s2)

Handle null.

asList

public static String asList(String[] values,
                            String separator)

boxify
```
public static String boxify(char boxing,
                            String text)
```
Returns a String which is surrounded by a box made of boxing char.

Parameters:

boxing - boxing character, eg '+'

text -

Returns:

anyEmpty
```
public static boolean anyEmpty(String... strings)
```
Parameters:

strings -

Returns:

true if any are empty

equalsIgnoreCaseOrValueIsWildcard

public static boolean equalsIgnoreCaseOrValueIsWildcard(String value,
                                                        String toCheck)

Does equalsIgnoreCase call but if the value is '*', immediately returns true.

Class StringUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEW_LINE

SINGLE_QUOTE

SLASH

NULL_COL

COMMA

DOT

SPACE

EMPTY

WILDCARD

STYLE

OPEN_PARENTHESES

CLOSE_PARENTHESES

Method Detail

removeTrailingChar

defaultFormatDatetime

defaultFileFormatTimestamp

replaceToken

replace

replaceToken

replaceCRToken

wrapText

trimAndUpperCase

toLowerCase

toUpperCase

processCaseTreatment

toString

toStringOrEmpty

singleQuote

isNotBlank

ifNotBlank

noneBlank

allEquals

equalsAnyIgnoreCase

equalsAnyIgnoreCase

concat

concatWithSpaces

emptyIfNull

isWildcardOrNull

returnIfNotNull

firstCharToUpper

trim

prepareForNumericParsing

nullIfEmpty

compareTo

asList

boxify

anyEmpty

equalsIgnoreCaseOrValueIsWildcard