org.hibernate.internal.util

Class StringHelper

java.lang.Object

org.hibernate.internal.util.StringHelper

public final class StringHelper
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringHelper.Renderer<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATCH_ID_PLACEHOLDER
static java.lang.String[]	EMPTY_STRINGS
static java.lang.String	WHITESPACE

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	add(java.lang.String[] x, java.lang.String sep, java.lang.String[] y)
static boolean	booleanValue(java.lang.String tfString)
static java.lang.StringBuilder	buildBatchFetchRestrictionFragment(java.lang.String alias, java.lang.String[] columnNames, Dialect dialect)
static java.lang.String	collapse(java.lang.String name) Collapses a name.
static java.lang.String	collapseQualifier(java.lang.String qualifier, boolean includeDots) Given a qualifier, collapse it.
static java.lang.String	collapseQualifierBase(java.lang.String name, java.lang.String qualifierBase) Cross between collapse(java.lang.String) and partiallyUnqualify(java.lang.String, java.lang.String).
static int	countUnquoted(java.lang.String string, char character)
static java.lang.String	expandBatchIdPlaceholder(java.lang.String sql, java.io.Serializable[] ids, java.lang.String alias, java.lang.String[] keyColumnNames, Dialect dialect)
static int	firstIndexOfChar(java.lang.String sqlString, java.util.BitSet keys, int startindex)
static int	firstIndexOfChar(java.lang.String sqlString, java.lang.String string, int startindex)
static java.lang.String	generateAlias(java.lang.String description)
static java.lang.String	generateAlias(java.lang.String description, int unique) Generate a nice alias for the given class name or collection role name and unique integer.
static char	getFirstNonWhitespaceCharacter(java.lang.String str)
static char	getLastNonWhitespaceCharacter(java.lang.String str)
static java.lang.String	getNonEmptyOrConjunctionIfBothNonEmpty(java.lang.String firstExpression, java.lang.String secondExpression)
static boolean	isEmpty(java.lang.String string)
static boolean	isEmptyOrWhiteSpace(java.lang.String string)
static boolean	isNotEmpty(java.lang.String string)
static boolean	isQuoted(java.lang.String name) Determine if the given string is quoted (wrapped by '`' characters at beginning and end).
static boolean	isQuoted(java.lang.String name, Dialect dialect) Determine if the given name is quoted.
static <T> java.lang.String	join(java.util.Collection<T> values, StringHelper.Renderer<T> renderer)
static java.lang.String	join(java.lang.String separator, java.lang.Iterable objects)
static java.lang.String	join(java.lang.String seperator, java.util.Iterator objects)
static java.lang.String	join(java.lang.String seperator, java.lang.String[] strings)
static <T> java.lang.String	join(T[] values, StringHelper.Renderer<T> renderer)
static java.lang.String	joinWithQualifierAndSuffix(java.lang.String[] values, java.lang.String qualifier, java.lang.String suffix, java.lang.String deliminator)
static int	lastIndexOfLetter(java.lang.String string)
static int[]	locateUnquoted(java.lang.String string, char character)
static java.lang.String	moveAndToBeginning(java.lang.String filter)
static java.lang.String[]	multiply(java.lang.String string, java.util.Iterator placeholders, java.util.Iterator replacements)
static java.lang.String	nullIfEmpty(java.lang.String value)
static java.util.List<java.lang.String>	parseCommaSeparatedString(java.lang.String incomingString)
static java.lang.String	partiallyUnqualify(java.lang.String name, java.lang.String qualifierBase) Partially unqualifies a qualified name.
static java.lang.String	qualifier(java.lang.String qualifiedName)
static java.lang.String	qualify(java.lang.String prefix, java.lang.String name)
static java.lang.String[]	qualify(java.lang.String prefix, java.lang.String[] names)
static java.lang.String	qualifyConditionally(java.lang.String prefix, java.lang.String name)
static java.lang.String[]	qualifyIfNot(java.lang.String prefix, java.lang.String[] names)
static java.lang.String	quote(java.lang.String name) Return a representation of the given name ensuring quoting (wrapped with '`' characters).
static java.lang.String	repeat(char character, int times)
static java.lang.String	repeat(java.lang.String string, int times)
static java.lang.String	repeat(java.lang.String string, int times, java.lang.String deliminator)
static java.lang.String[]	replace(java.lang.String[] templates, java.lang.String placeholder, java.lang.String replacement)
static java.lang.String	replace(java.lang.String template, java.lang.String placeholder, java.lang.String replacement)
static java.lang.String	replace(java.lang.String template, java.lang.String placeholder, java.lang.String replacement, boolean wholeWords)
static java.lang.String	replace(java.lang.String template, java.lang.String placeholder, java.lang.String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)
static java.lang.String	replace(java.lang.String beforePlaceholder, java.lang.String afterPlaceholder, java.lang.String placeholder, java.lang.String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)
static java.lang.String	replaceOnce(java.lang.String template, java.lang.String placeholder, java.lang.String replacement)
static java.lang.String	root(java.lang.String qualifiedName)
static java.lang.String[]	split(java.lang.String separators, java.lang.String list)
static java.lang.String[]	split(java.lang.String separators, java.lang.String list, boolean include)
static java.lang.String[]	splitTrimmingTokens(java.lang.String separators, java.lang.String list, boolean include)
static java.lang.String[]	suffix(java.lang.String[] columns, java.lang.String suffix)
static java.lang.String[]	toArrayElement(java.lang.String s) Takes a String s and returns a new String[1] with s as the only element.
static java.lang.String	toString(java.lang.Object[] array)
static java.lang.String	truncate(java.lang.String string, int length)
static java.lang.String	unqualify(java.lang.String qualifiedName)
static java.lang.String	unqualifyEntityName(java.lang.String entityName)
static java.lang.String	unquote(java.lang.String name) Return the unquoted version of name (stripping the start and end '`' characters if present).
static java.lang.String[]	unquote(java.lang.String[] names, Dialect dialect) Return the unquoted version of name stripping the start and end quote characters.
static java.lang.String	unquote(java.lang.String name, Dialect dialect) Return the unquoted version of name stripping the start and end quote characters.
static java.lang.String	unroot(java.lang.String qualifiedName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WHITESPACE

public static final java.lang.String WHITESPACE

See Also:

Constant Field Values

EMPTY_STRINGS

public static final java.lang.String[] EMPTY_STRINGS

BATCH_ID_PLACEHOLDER

public static final java.lang.String BATCH_ID_PLACEHOLDER

See Also:

Constant Field Values

Method Detail

lastIndexOfLetter

public static int lastIndexOfLetter(java.lang.String string)

join

public static java.lang.String join(java.lang.String seperator,
                                    java.lang.String[] strings)

joinWithQualifierAndSuffix

public static java.lang.String joinWithQualifierAndSuffix(java.lang.String[] values,
                                                          java.lang.String qualifier,
                                                          java.lang.String suffix,
                                                          java.lang.String deliminator)

join

public static java.lang.String join(java.lang.String seperator,
                                    java.util.Iterator objects)

join

public static java.lang.String join(java.lang.String separator,
                                    java.lang.Iterable objects)

add

public static java.lang.String[] add(java.lang.String[] x,
                                     java.lang.String sep,
                                     java.lang.String[] y)

repeat

public static java.lang.String repeat(java.lang.String string,
                                      int times)

repeat

public static java.lang.String repeat(java.lang.String string,
                                      int times,
                                      java.lang.String deliminator)

repeat

public static java.lang.String repeat(char character,
                                      int times)

replace

public static java.lang.String replace(java.lang.String template,
                                       java.lang.String placeholder,
                                       java.lang.String replacement)

replace

public static java.lang.String[] replace(java.lang.String[] templates,
                                         java.lang.String placeholder,
                                         java.lang.String replacement)

replace

public static java.lang.String replace(java.lang.String template,
                                       java.lang.String placeholder,
                                       java.lang.String replacement,
                                       boolean wholeWords)

replace

public static java.lang.String replace(java.lang.String template,
                                       java.lang.String placeholder,
                                       java.lang.String replacement,
                                       boolean wholeWords,
                                       boolean encloseInParensIfNecessary)

replace

public static java.lang.String replace(java.lang.String beforePlaceholder,
                                       java.lang.String afterPlaceholder,
                                       java.lang.String placeholder,
                                       java.lang.String replacement,
                                       boolean wholeWords,
                                       boolean encloseInParensIfNecessary)

getLastNonWhitespaceCharacter

public static char getLastNonWhitespaceCharacter(java.lang.String str)

getFirstNonWhitespaceCharacter

public static char getFirstNonWhitespaceCharacter(java.lang.String str)

replaceOnce

public static java.lang.String replaceOnce(java.lang.String template,
                                           java.lang.String placeholder,
                                           java.lang.String replacement)

split

public static java.lang.String[] split(java.lang.String separators,
                                       java.lang.String list)

split

public static java.lang.String[] split(java.lang.String separators,
                                       java.lang.String list,
                                       boolean include)

splitTrimmingTokens

public static java.lang.String[] splitTrimmingTokens(java.lang.String separators,
                                                     java.lang.String list,
                                                     boolean include)

unqualify

public static java.lang.String unqualify(java.lang.String qualifiedName)

qualifier

public static java.lang.String qualifier(java.lang.String qualifiedName)

collapse

public static java.lang.String collapse(java.lang.String name)

Collapses a name. Mainly intended for use with classnames, where an example might serve best to explain. Imagine you have a class named 'org.hibernate.internal.util.StringHelper'; calling collapse on that classname will result in 'o.h.u.StringHelper'.

Parameters:

name - The name to collapse.

Returns:

The collapsed name.

collapseQualifier

public static java.lang.String collapseQualifier(java.lang.String qualifier,
                                                 boolean includeDots)

Given a qualifier, collapse it.

Parameters:

qualifier - The qualifier to collapse.

includeDots - Should we include the dots in the collapsed form?

Returns:

The collapsed form.

partiallyUnqualify

public static java.lang.String partiallyUnqualify(java.lang.String name,
                                                  java.lang.String qualifierBase)

Partially unqualifies a qualified name. For example, with a base of 'org.hibernate' the name 'org.hibernate.internal.util.StringHelper' would become 'util.StringHelper'.

Parameters:

name - The (potentially) qualified name.

qualifierBase - The qualifier base.

Returns:

The name itself, or the partially unqualified form if it begins with the qualifier base.

collapseQualifierBase

public static java.lang.String collapseQualifierBase(java.lang.String name,
                                                     java.lang.String qualifierBase)

Cross between collapse(java.lang.String) and partiallyUnqualify(java.lang.String, java.lang.String). Functions much like collapse(java.lang.String) except that only the qualifierBase is collapsed. For example, with a base of 'org.hibernate' the name 'org.hibernate.internal.util.StringHelper' would become 'o.h.util.StringHelper'.

Parameters:

name - The (potentially) qualified name.

qualifierBase - The qualifier base.

Returns:

The name itself if it does not begin with the qualifierBase, or the properly collapsed form otherwise.

suffix

public static java.lang.String[] suffix(java.lang.String[] columns,
                                        java.lang.String suffix)

root

public static java.lang.String root(java.lang.String qualifiedName)

unroot

public static java.lang.String unroot(java.lang.String qualifiedName)

booleanValue

public static boolean booleanValue(java.lang.String tfString)

toString

public static java.lang.String toString(java.lang.Object[] array)

multiply

public static java.lang.String[] multiply(java.lang.String string,
                                          java.util.Iterator placeholders,
                                          java.util.Iterator replacements)

countUnquoted

public static int countUnquoted(java.lang.String string,
                                char character)

locateUnquoted

public static int[] locateUnquoted(java.lang.String string,
                                   char character)

isNotEmpty

public static boolean isNotEmpty(java.lang.String string)

isEmpty

public static boolean isEmpty(java.lang.String string)

isEmptyOrWhiteSpace

public static boolean isEmptyOrWhiteSpace(java.lang.String string)

qualify

public static java.lang.String qualify(java.lang.String prefix,
                                       java.lang.String name)

qualifyConditionally

public static java.lang.String qualifyConditionally(java.lang.String prefix,
                                                    java.lang.String name)

qualify

public static java.lang.String[] qualify(java.lang.String prefix,
                                         java.lang.String[] names)

qualifyIfNot

public static java.lang.String[] qualifyIfNot(java.lang.String prefix,
                                              java.lang.String[] names)

firstIndexOfChar

public static int firstIndexOfChar(java.lang.String sqlString,
                                   java.util.BitSet keys,
                                   int startindex)

firstIndexOfChar

public static int firstIndexOfChar(java.lang.String sqlString,
                                   java.lang.String string,
                                   int startindex)

truncate

public static java.lang.String truncate(java.lang.String string,
                                        int length)

generateAlias

public static java.lang.String generateAlias(java.lang.String description)

generateAlias

public static java.lang.String generateAlias(java.lang.String description,
                                             int unique)

Generate a nice alias for the given class name or collection role name and unique integer. Subclasses of Loader do not have to use aliases of this form.

Parameters:

description - The base name (usually an entity-name or collection-role)

unique - A uniquing value

Returns:

an alias of the form foo1_

unqualifyEntityName

public static java.lang.String unqualifyEntityName(java.lang.String entityName)

moveAndToBeginning

public static java.lang.String moveAndToBeginning(java.lang.String filter)

isQuoted

public static boolean isQuoted(java.lang.String name)

Determine if the given string is quoted (wrapped by '`' characters at beginning and end).

Parameters:

name - The name to check.

Returns:

True if the given string starts and ends with '`'; false otherwise.

quote

public static java.lang.String quote(java.lang.String name)

Return a representation of the given name ensuring quoting (wrapped with '`' characters). If already wrapped return name.

Parameters:

name - The name to quote.

Returns:

The quoted version.

unquote

public static java.lang.String unquote(java.lang.String name)

Return the unquoted version of name (stripping the start and end '`' characters if present).

Parameters:

name - The name to be unquoted.

Returns:

The unquoted version.

isQuoted

public static boolean isQuoted(java.lang.String name,
                               Dialect dialect)

Determine if the given name is quoted. It is considered quoted if either:

1. starts AND ends with backticks (`)
2. starts with dialect-specified open-quote AND ends with dialect-specified close-quote

Parameters:

name - The name to check

dialect - The dialect (to determine the "real" quoting chars).

Returns:

True if quoted, false otherwise

unquote

public static java.lang.String unquote(java.lang.String name,
                                       Dialect dialect)

Return the unquoted version of name stripping the start and end quote characters.

Parameters:

name - The name to be unquoted.

dialect - The dialect (to determine the "real" quoting chars).

Returns:

The unquoted version.

unquote

public static java.lang.String[] unquote(java.lang.String[] names,
                                         Dialect dialect)

Return the unquoted version of name stripping the start and end quote characters.

Parameters:

names - The names to be unquoted.

dialect - The dialect (to determine the "real" quoting chars).

Returns:

The unquoted versions.

buildBatchFetchRestrictionFragment

public static java.lang.StringBuilder buildBatchFetchRestrictionFragment(java.lang.String alias,
                                                                         java.lang.String[] columnNames,
                                                                         Dialect dialect)

expandBatchIdPlaceholder

public static java.lang.String expandBatchIdPlaceholder(java.lang.String sql,
                                                        java.io.Serializable[] ids,
                                                        java.lang.String alias,
                                                        java.lang.String[] keyColumnNames,
                                                        Dialect dialect)

toArrayElement

public static java.lang.String[] toArrayElement(java.lang.String s)

Takes a String s and returns a new String[1] with s as the only element. If s is null or "", return String[0].

Parameters:

s -

Returns:

String[]

nullIfEmpty

public static java.lang.String nullIfEmpty(java.lang.String value)

parseCommaSeparatedString

public static java.util.List<java.lang.String> parseCommaSeparatedString(java.lang.String incomingString)

join

public static <T> java.lang.String join(java.util.Collection<T> values,
                                        StringHelper.Renderer<T> renderer)

join

public static <T> java.lang.String join(T[] values,
                                        StringHelper.Renderer<T> renderer)

getNonEmptyOrConjunctionIfBothNonEmpty

public static java.lang.String getNonEmptyOrConjunctionIfBothNonEmpty(java.lang.String firstExpression,
                                                                      java.lang.String secondExpression)

Parameters:

firstExpression - the first expression

secondExpression - the second expression

Returns:

if firstExpression and secondExpression are both non-empty, then "( " + firstExpression + " ) and ( " + secondExpression + " )" is returned; if firstExpression is non-empty and secondExpression is empty, then firstExpression is returned; if firstExpression is empty and secondExpression is non-empty, then secondExpression is returned; if both firstExpression and secondExpression are empty, then null is returned.