Module io.github.mmm.base

Package io.github.mmm.base.text

Class CaseSyntax

java.lang.Object

io.github.mmm.base.text.CaseSyntax

public class CaseSyntax
extends Object

Defines the different styles of lower-/upper-case usage such as camlCase, train-case, etc. For further examples see the constants defined here in CaseSyntax.
The main idea is that you "parse" a given variable name syntax via ofExample(String, boolean) and then you can transform the value of such variable via convert(String). As a small teaser and motivation here are some examples assuming that the value for "VaraibleName" would be "MyValue":

VariableSyntax	Result
VariableName	MyValue
variablename	myvalue
variable-name	my-value
VARIABLE_NAME	MY_VALUE
variableName	myValue

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CaseSyntax	CAML_CASE	CaseSyntax for camlCase (e.g.
static final CaseSyntax	CAML_SNAKE_CASE	CaseSyntax for caml_Snake_Case.
static final CaseSyntax	CAML_SPACE_CASE	CaseSyntax for caml Space Case.
static final CaseSyntax	CAML_TRAIN_CASE	CaseSyntax for caml-Train-Case.
static final CaseSyntax	CAPITALIZED	CaseSyntax for C$$apitalized (only convert first char to upper case, keep other case untouched).
static final CaseSyntax	CAPITALIZED_LOWER	CaseSyntax for Capitalizedlower.
static final Character	KEEP_SPECIAL_CHARS	The word separator used to keep any special (separator) characters untouched by convert.
static final CaseSyntax	LOWER_SNAKE_CASE	CaseSyntax for lower_snake_case (e.g.
static final CaseSyntax	LOWER_SPACE_CASE	CaseSyntax for lower space case.
static final CaseSyntax	LOWERCASE	CaseSyntax for lowercase (e.g.
static final CaseSyntax	PASCAL_CASE	CaseSyntax for PascalCase (e.g.
static final CaseSyntax	PASCAL_SNAKE_CASE	CaseSyntax for Pascal_Snake_Case.
static final CaseSyntax	PASCAL_SPACE_CASE	CaseSyntax for Pascal Space Case.
static final CaseSyntax	PASCAL_TRAIN_CASE	CaseSyntax for Pascal-Train-Case.
static final CaseSyntax	TRAIN_CASE	CaseSyntax for train-case (e.g.
static final CaseSyntax	UNCAPITALIZED	CaseSyntax for u$$capitalized (only convert first char to lower case, keep other case untouched).
static final CaseSyntax	UNCAPITALIZED_UPPER	CaseSyntax for Capitalizedlower.
static final CaseSyntax	UNMODIFIED	CaseSyntax for $$$unmodified (keep all characters untouched).
static final CaseSyntax	UPPER_SNAKE_CASE	CaseSyntax for UPPER_SNAKE_CASE (e.g.
static final CaseSyntax	UPPER_SPACE_CASE	CaseSyntax for UPPER SPACE CASE.
static final CaseSyntax	UPPER_TRAIN_CASE	CaseSyntax for UPPER-TRAIN-CASE.
static final CaseSyntax	UPPERCASE	CaseSyntax for UPPERCASE.

Method Summary

Modifier and Type	Method	Description
String	convert(String string)	Same as convert(String, Locale) with a standard Locale to prevent accidental conversion.
String	convert(String string, Locale locale)	Converts to this CaseSyntax.
boolean	equals(Object obj)
CaseConversion	getFirstCase()
CaseConversion	getOtherCase()
Character	getWordSeparator()
CaseConversion	getWordStartCase()
int	hashCode()
boolean	hasWordSeparator()
static String	normalizeExample(String example)
static CaseSyntax	of(Character separator, CaseConversion allCharCase)	The constructor.
static CaseSyntax	of(Character separator, CaseConversion firstCharCase, CaseConversion wordStartCharCase)	The constructor.
static CaseSyntax	of(Character separator, CaseConversion firstCharCase, CaseConversion wordStartCharCase, CaseConversion otherCharCase)
static CaseSyntax	ofExample(String example)
static CaseSyntax	ofExample(String example, boolean standardize)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

KEEP_SPECIAL_CHARS

public static final Character KEEP_SPECIAL_CHARS

The word separator used to keep any special (separator) characters untouched by convert.

LOWERCASE

public static final CaseSyntax LOWERCASE

CaseSyntax for lowercase (e.g. for Java package segments).

UPPERCASE

public static final CaseSyntax UPPERCASE

CaseSyntax for UPPERCASE.

CAML_CASE

public static final CaseSyntax CAML_CASE

CaseSyntax for camlCase (e.g. for Java fields).

PASCAL_CASE

public static final CaseSyntax PASCAL_CASE

CaseSyntax for PascalCase (e.g. for Java types).

TRAIN_CASE

public static final CaseSyntax TRAIN_CASE

CaseSyntax for train-case (e.g. for URLs or Angular).

UPPER_TRAIN_CASE

public static final CaseSyntax UPPER_TRAIN_CASE

CaseSyntax for UPPER-TRAIN-CASE.

PASCAL_TRAIN_CASE

public static final CaseSyntax PASCAL_TRAIN_CASE

CaseSyntax for Pascal-Train-Case.

CAML_TRAIN_CASE

public static final CaseSyntax CAML_TRAIN_CASE

CaseSyntax for caml-Train-Case.

LOWER_SNAKE_CASE

public static final CaseSyntax LOWER_SNAKE_CASE

CaseSyntax for lower_snake_case (e.g. for Ruby).

UPPER_SNAKE_CASE

public static final CaseSyntax UPPER_SNAKE_CASE

CaseSyntax for UPPER_SNAKE_CASE (e.g. for Java constants).

PASCAL_SNAKE_CASE

public static final CaseSyntax PASCAL_SNAKE_CASE

CaseSyntax for Pascal_Snake_Case.

CAML_SNAKE_CASE

public static final CaseSyntax CAML_SNAKE_CASE

CaseSyntax for caml_Snake_Case.

LOWER_SPACE_CASE

public static final CaseSyntax LOWER_SPACE_CASE

CaseSyntax for lower space case.

UPPER_SPACE_CASE

public static final CaseSyntax UPPER_SPACE_CASE

CaseSyntax for UPPER SPACE CASE.

PASCAL_SPACE_CASE

public static final CaseSyntax PASCAL_SPACE_CASE

CaseSyntax for Pascal Space Case.

CAML_SPACE_CASE

public static final CaseSyntax CAML_SPACE_CASE

CaseSyntax for caml Space Case.

UNMODIFIED

public static final CaseSyntax UNMODIFIED

CaseSyntax for $$$unmodified (keep all characters untouched).

CAPITALIZED

public static final CaseSyntax CAPITALIZED

CaseSyntax for C$$apitalized (only convert first char to upper case, keep other case untouched).

UNCAPITALIZED

public static final CaseSyntax UNCAPITALIZED

CaseSyntax for u$$capitalized (only convert first char to lower case, keep other case untouched).

CAPITALIZED_LOWER

public static final CaseSyntax CAPITALIZED_LOWER

CaseSyntax for Capitalizedlower.

UNCAPITALIZED_UPPER

public static final CaseSyntax UNCAPITALIZED_UPPER

CaseSyntax for Capitalizedlower.

Method Details

getWordSeparator

public Character getWordSeparator()

Returns:

the word separator char (e.g. '_','-' or '.') or null for no word separator. The value KEEP_SPECIAL_CHARS can be used to keep special characters untouched.

hasWordSeparator

public boolean hasWordSeparator()

Returns:

true if the word separator is null or

getFirstCase

public CaseConversion getFirstCase()

Returns:

the CaseConversion used by convert(String) for the first character.

getWordStartCase

public CaseConversion getWordStartCase()

Returns:

the CaseConversion used by convert(String) for word start characters (the first character of a new word except for the first character of the entire String).

getOtherCase

public CaseConversion getOtherCase()

Returns:

the CaseConversion used by convert(String) for all other characters (except first and word start characters).

convert

public String convert(String string)

Same as convert(String, Locale) with a standard Locale to prevent accidental conversion.

Parameters:

string - the String to convert.

Returns:

the String converted to this CaseSyntax.

convert

public String convert(String string,
 Locale locale)

Converts to this CaseSyntax. The first character will be converted using getFirstCase(). Characters other than letters or digits are considered as word separator. In the most cases, they will be

Parameters:

string - the String to convert.

locale - the explicit Locale to use. In most cases you want to use convert(String) instead.

Returns:

the String converted to this CaseSyntax.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static CaseSyntax of(Character separator,
 CaseConversion allCharCase)

The constructor.

Parameters:

separator - - see getWordSeparator().

allCharCase - the CaseConversion used for first, word-start, and all other alphabetic characters.

Returns:

the requested CaseSyntax.

of

public static CaseSyntax of(Character separator,
 CaseConversion firstCharCase,
 CaseConversion wordStartCharCase)

The constructor. Will use CaseConversion.LOWER_CASE for other characters.

Parameters:

separator - - see getWordSeparator().

firstCharCase - - see getFirstCase().

wordStartCharCase - - see getWordStartCase().

Returns:

the requested CaseSyntax.

of

public static CaseSyntax of(Character separator,
 CaseConversion firstCharCase,
 CaseConversion wordStartCharCase,
 CaseConversion otherCharCase)

Parameters:

separator - - see getWordSeparator().

firstCharCase - - see getFirstCase().

wordStartCharCase - - see getWordStartCase().

otherCharCase - - see getOtherCase().

Returns:

the requested CaseSyntax.

normalizeExample

public static String normalizeExample(String example)

Parameters:

example - the example to normalize.

Returns:

the normalized example (in lower case with all special characters removed).

ofExample

public static CaseSyntax ofExample(String example)

Parameters:

example - an example for the requested CaseSyntax such as PascalCase or MyVariableName for PASCAL_CASE. For further details see ofExample(String, boolean).

Returns:

the CaseSyntax for the given example as described above.

See Also:

• ofExample(String, boolean)

ofExample

public static CaseSyntax ofExample(String example,
 boolean standardize)

Parameters:

example - an example for the requested CaseSyntax such as PascalCase or MyVariableName for PASCAL_CASE and train-case or my-variable-name for TRAIN_CASE. See other CaseSyntax constants for more examples. The given example String has to start with a letter with an underscore for KEEP_SPECIAL_CHARS, or with $-Sign) and contain at least two more such characters (letter or $-sign) next to each other. Digits are more or less ignored. If you use variable names as example consider naming such variables with more than one word and no characters other than letters or digits. Otherwise you would have to write things such as ComPonent or com-ponent to indicate PascalCase or train-case for the variable component. Also when using variables as CaseSyntax example you should normalizeExample(String) normalize} them before resolving.

standardize - - true if existing constants such as PASCAL_CASE or TRAIN_CASE shall be returned if equal to the requested CaseSyntax, false otherwise.

Returns:

the CaseSyntax for the given example as described above.