Hibernate Core 3.6.10.Final · org.hibernate.util.StringHelper

Modifier and Type	Field and Description
private static final int	ALIAS_TRUNCATE_LENGTH
public static final String	WHITESPACE

Access	Constructor and Description
private	StringHelper()

Method Summary

Modifier and Type	Method and Description
public static String[]	add(String[] x, String sep, String[] y)
public static boolean	booleanValue(String tfString)
private static String	Returns: The cleaned alias, stripped of any leading non-alpha characters. cleanAlias(String The generated alias to be cleaned. alias) Clean the generated alias by removing any non-alpha characters from the beginning.
public static String	Returns: The collapsed name. collapse(String The name to collapse. name) Collapses a name.
public static String	Returns: The collapsed form. collapseQualifier(String The qualifier to collapse. qualifier, boolean Should we include the dots in the collapsed form? includeDots) Given a qualifier, collapse it.
public static String	Returns: The name itself if it does not begin with the qualifierBase, or the properly collapsed form otherwise. collapseQualifierBase(String The (potentially) qualified name. name, String The qualifier base. qualifierBase) Cross between `collapse` and `partiallyUnqualify`.
public static int	countUnquoted(String string, char character)
public static int	firstIndexOfChar(String sqlString, String string, int startindex)
public static String	generateAlias(String description)
public static String	Returns: an alias of the form `foo1_` generateAlias(String The base name (usually an entity-name or collection-role) description, int A uniquing value unique) Generate a nice alias for the given class name or collection role name and unique integer.
private static String	Returns: The generated root alias. generateAliasRoot(String The root name from which to generate a root alias. description) Generates a root alias by truncating the "root name" defined by the incoming decription and removing/modifying any non-valid alias characters.
public static char	getFirstNonWhitespaceCharacter(String str)
public static char	getLastNonWhitespaceCharacter(String str)
public static boolean	isEmpty(String string)
public static boolean	isNotEmpty(String string)
public static boolean	Returns: True if the given string starts and ends with '`'; false otherwise. isQuoted(String The name to check. name) Determine if the given string is quoted (wrapped by '`' characters at beginning and end).
public static boolean	Returns: True if quoted, false otherwise isQuoted(String The name to check name, Dialect The dialect (to determine the "real" quoting chars). dialect) Determine if the given name is quoted.
public static String	join(String seperator, String[] strings)
public static String	join(String seperator, Iterator<E> objects)
public static int	lastIndexOfLetter(String string)
public static int[]	locateUnquoted(String string, char character)
public static String	moveAndToBeginning(String filter)
public static String[]	multiply(String string, Iterator<E> placeholders, Iterator<E> replacements)
private static String[]	multiply(String[] strings, String placeholder, String[] replacements)
public static String	Returns: The name itself, or the partially unqualified form if it begins with the qualifier base. partiallyUnqualify(String The (potentially) qualified name. name, String The qualifier base. qualifierBase) Partially unqualifies a qualified name.
public static String	qualifier(String qualifiedName)
public static String	qualify(String prefix, String name)
public static String[]	qualify(String prefix, String[] names)
public static String	Returns: The quoted version. quote(String The name to quote. name) Return a representation of the given name ensuring quoting (wrapped with '`' characters).
public static String	repeat(String string, int times)
public static String	repeat(char character, int times)
public static String	replace(String template, String placeholder, String replacement)
public static String[]	replace(String[] templates, String placeholder, String replacement)
public static String	replace(String template, String placeholder, String replacement, boolean wholeWords)
public static String	replace(String template, String placeholder, String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)
public static String	replace(String beforePlaceholder, String afterPlaceholder, String placeholder, String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)
public static String	replaceOnce(String template, String placeholder, String replacement)
public static String	root(String qualifiedName)
public static String[]	split(String seperators, String list)
public static String[]	split(String seperators, String list, boolean include)
public static String[]	suffix(String[] columns, String suffix)
private static String	suffix(String name, String suffix)
public static String	toLowerCase(String str)
public static String	toString(Object[] array)
public static String	toUpperCase(String str)
public static String	truncate(String string, int length)
public static String	unqualify(String qualifiedName)
public static String	unqualifyEntityName(String entityName)
public static String	Returns: The unquoted version. unquote(String The name to be unquoted. name) Return the unquoted version of name (stripping the start and end '`' characters if present).
public static String	Returns: The unquoted version. unquote(String The name to be unquoted. name, Dialect The dialect (to determine the "real" quoting chars). dialect) Return the unquoted version of name stripping the start and end quote characters.
public static String[]	Returns: The unquoted versions. unquote(String[] The names to be unquoted. names, Dialect The dialect (to determine the "real" quoting chars). dialect) Return the unquoted version of name stripping the start and end quote characters.
public static String	unroot(String qualifiedName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ALIAS_TRUNCATE_LENGTH	back to summary
private static final int ALIAS_TRUNCATE_LENGTH

WHITESPACE	back to summary
public static final String WHITESPACE

StringHelper	back to summary
private StringHelper()

Method Detail

add	back to summary
public static String[] add(String[] x, String sep, String[] y)

booleanValue	back to summary
public static boolean booleanValue(String tfString)

cleanAlias	back to summary
private static String cleanAlias(String alias) Clean the generated alias by removing any non-alpha characters from the beginning. Parameters alias:String The generated alias to be cleaned. Returns:String The cleaned alias, stripped of any leading non-alpha characters.

cleanAlias

back to summary

private static String cleanAlias(String alias)

Clean the generated alias by removing any non-alpha characters from the beginning.

Parameters

alias:String: The generated alias to be cleaned.

Returns:String

The cleaned alias, stripped of any leading non-alpha characters.

collapse	back to summary
public static String collapse(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.util.StringHelper'`; calling collapse on that classname will result in `'o.h.u.StringHelper'.` Parameters name:String The name to collapse. Returns:String The collapsed name.

collapse

back to summary

public static String collapse(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.util.StringHelper'; calling collapse on that classname will result in 'o.h.u.StringHelper'.

Parameters

name:String: The name to collapse.

Returns:String

The collapsed name.

collapseQualifier	back to summary
public static String collapseQualifier(String qualifier, boolean includeDots) Given a qualifier, collapse it. Parameters qualifier:String The qualifier to collapse. includeDots:boolean Should we include the dots in the collapsed form? Returns:String The collapsed form.

collapseQualifier

back to summary

public static String collapseQualifier(String qualifier, boolean includeDots)

Given a qualifier, collapse it.

Parameters

qualifier:String: The qualifier to collapse.
includeDots:boolean: Should we include the dots in the collapsed form?

Returns:String

The collapsed form.

collapseQualifierBase back to summary

collapseQualifierBase	back to summary
public static String collapseQualifierBase(String name, String qualifierBase) Cross between `collapse` and `partiallyUnqualify`. Functions much like `collapse` except that only the qualifierBase is collapsed. For example, with a base of 'org.hibernate' the name 'org.hibernate.util.StringHelper' would become 'o.h.util.StringHelper'. Parameters name:String The (potentially) qualified name. qualifierBase:String The qualifier base. Returns:String The name itself if it does not begin with the qualifierBase, or the properly collapsed form otherwise.

public static String collapseQualifierBase(String name, String qualifierBase)

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

Parameters

name:String: The (potentially) qualified name.
qualifierBase:String: The qualifier base.

Returns:String

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

countUnquoted	back to summary
public static int countUnquoted(String string, char character)

firstIndexOfChar	back to summary
public static int firstIndexOfChar(String sqlString, String string, int startindex)

generateAlias	back to summary
public static String generateAlias(String description)

generateAlias	back to summary
public static String generateAlias(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:String The base name (usually an entity-name or collection-role) unique:int A uniquing value Returns:String an alias of the form `foo1_`

generateAlias

back to summary

public static String generateAlias(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:String: The base name (usually an entity-name or collection-role)
unique:int: A uniquing value

Returns:String

an alias of the form foo1_

generateAliasRoot	back to summary
private static String generateAliasRoot(String description) Generates a root alias by truncating the "root name" defined by the incoming decription and removing/modifying any non-valid alias characters. Parameters description:String The root name from which to generate a root alias. Returns:String The generated root alias.

generateAliasRoot

back to summary

private static String generateAliasRoot(String description)

Generates a root alias by truncating the "root name" defined by the incoming decription and removing/modifying any non-valid alias characters.

Parameters

description:String: The root name from which to generate a root alias.

Returns:String

The generated root alias.

getFirstNonWhitespaceCharacter	back to summary
public static char getFirstNonWhitespaceCharacter(String str)

getLastNonWhitespaceCharacter	back to summary
public static char getLastNonWhitespaceCharacter(String str)

isEmpty	back to summary
public static boolean isEmpty(String string)

isNotEmpty	back to summary
public static boolean isNotEmpty(String string)

isQuoted	back to summary
public static boolean isQuoted(String name) Determine if the given string is quoted (wrapped by '`' characters at beginning and end). Parameters name:String The name to check. Returns:boolean True if the given string starts and ends with '`'; false otherwise.

isQuoted

back to summary

public static boolean isQuoted(String name)

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

Parameters

name:String: The name to check.

Returns:boolean

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

isQuoted back to summary

isQuoted	back to summary
public static boolean isQuoted(String name, Dialect dialect) Determine if the given name is quoted. It is considered quoted if either: starts AND ends with backticks (`) starts with dialect-specified `open-quote` AND ends with dialect-specified `close-quote` Parameters name:String The name to check dialect:Dialect The dialect (to determine the "real" quoting chars). Returns:boolean True if quoted, false otherwise

public static boolean isQuoted(String name, Dialect dialect)

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

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

Parameters

name:String: The name to check
dialect:Dialect: The dialect (to determine the "real" quoting chars).

Returns:boolean

True if quoted, false otherwise

join	back to summary
public static String join(String seperator, String[] strings)

join	back to summary
public static String join(String seperator, Iterator<E> objects)

lastIndexOfLetter	back to summary
public static int lastIndexOfLetter(String string)

locateUnquoted	back to summary
public static int[] locateUnquoted(String string, char character)

moveAndToBeginning	back to summary
public static String moveAndToBeginning(String filter)

multiply	back to summary
public static String[] multiply(String string, Iterator<E> placeholders, Iterator<E> replacements)

multiply	back to summary
private static String[] multiply(String[] strings, String placeholder, String[] replacements)

partiallyUnqualify	back to summary
public static String partiallyUnqualify(String name, String qualifierBase) Partially unqualifies a qualified name. For example, with a base of 'org.hibernate' the name 'org.hibernate.util.StringHelper' would become 'util.StringHelper'. Parameters name:String The (potentially) qualified name. qualifierBase:String The qualifier base. Returns:String The name itself, or the partially unqualified form if it begins with the qualifier base.

partiallyUnqualify

back to summary

public static String partiallyUnqualify(String name, String qualifierBase)

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

Parameters

name:String: The (potentially) qualified name.
qualifierBase:String: The qualifier base.

Returns:String

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

qualifier	back to summary
public static String qualifier(String qualifiedName)

qualify	back to summary
public static String qualify(String prefix, String name)

qualify	back to summary
public static String[] qualify(String prefix, String[] names)

quote	back to summary
public static String quote(String name) Return a representation of the given name ensuring quoting (wrapped with '`' characters). If already wrapped return name. Parameters name:String The name to quote. Returns:String The quoted version.

quote

back to summary

public static String quote(String name)

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

Parameters

name:String: The name to quote.

Returns:String

The quoted version.

repeat	back to summary
public static String repeat(String string, int times)

repeat	back to summary
public static String repeat(char character, int times)

replace	back to summary
public static String replace(String template, String placeholder, String replacement)

replace	back to summary
public static String[] replace(String[] templates, String placeholder, String replacement)

replace	back to summary
public static String replace(String template, String placeholder, String replacement, boolean wholeWords)

replace	back to summary
public static String replace(String template, String placeholder, String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)

replace	back to summary
public static String replace(String beforePlaceholder, String afterPlaceholder, String placeholder, String replacement, boolean wholeWords, boolean encloseInParensIfNecessary)

replaceOnce	back to summary
public static String replaceOnce(String template, String placeholder, String replacement)

root	back to summary
public static String root(String qualifiedName)

split	back to summary
public static String[] split(String seperators, String list)

split	back to summary
public static String[] split(String seperators, String list, boolean include)

suffix	back to summary
public static String[] suffix(String[] columns, String suffix)

suffix	back to summary
private static String suffix(String name, String suffix)

toLowerCase	back to summary
public static String toLowerCase(String str)

toString	back to summary
public static String toString(Object[] array)

toUpperCase	back to summary
public static String toUpperCase(String str)

truncate	back to summary
public static String truncate(String string, int length)

unqualify	back to summary
public static String unqualify(String qualifiedName)

unqualifyEntityName	back to summary
public static String unqualifyEntityName(String entityName)

unquote

back to summary

public static String unquote(String name)

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

Parameters

name:String: The name to be unquoted.

Returns:String

The unquoted version.

unquote

back to summary

public static String unquote(String name, Dialect dialect)

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

Parameters

name:String: The name to be unquoted.
dialect:Dialect: The dialect (to determine the "real" quoting chars).

Returns:String

The unquoted version.

unquote

back to summary

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

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

Parameters

names:String[]: The names to be unquoted.
dialect:Dialect: The dialect (to determine the "real" quoting chars).

Returns:String[]

The unquoted versions.

unroot	back to summary
public static String unroot(String qualifiedName)

public final Class StringHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail