de.larssh.utils.text

Class SentenceFormatter

java.lang.Object

de.larssh.utils.text.SentenceFormatter

public class SentenceFormatter
extends Object

Class to format and parse a list of words.

Constants define instances of common formatters. The following is an example using the words abc, def and ghi.

Examples

Formatter	Example
LOWER_CAMEL_CASE	abcDefGhi
LOWER_KEBAB_CASE	abc-def-ghi
LOWER_SNAKE_CASE	abc_def_ghi
LOWER_WHITE_SPACE	Abc def ghi
UPPER_CAMEL_CASE	AbcDefGhi
UPPER_KEBAB_CASE	ABC-DEF-GHI
UPPER_SNAKE_CASE	ABC_DEF_GHI
UPPER_WHITE_SPACE	Abc Def Ghi

Field Summary

Fields

Modifier and Type	Field and Description
static SentenceFormatter	LOWER_CAMEL_CASE Lower Camel Case formatter Example: abcDefGhi Words are translated to title case, except the first words, which is translated to lower case.
static SentenceFormatter	LOWER_KEBAB_CASE Lower Kebab Case formatter Example: abc-def-ghi Words are translated to lower case and are separated by minus character.
static SentenceFormatter	LOWER_SNAKE_CASE Lower Snake Case formatter Example: abc_def_ghi Words are translated to lower case and are separated by underscore character.
static SentenceFormatter	LOWER_WHITE_SPACE Lower White Space formatter Example: Abc def ghi Words are translated to lower case, except the first word, which is translated to title case, and are separated by white space character.
static SentenceFormatter	UPPER_CAMEL_CASE Upper Camel Case formatter Example: AbcDefGhi Words are translated to title case.
static SentenceFormatter	UPPER_KEBAB_CASE Upper Kebab Case formatter Example: ABC-DEF-GHI Words are translated to upper case and are separated by minus character.
static SentenceFormatter	UPPER_SNAKE_CASE Upper Snake Case formatter Example: ABC_DEF_GHI Words are translated to upper case and are separated by underscore character.
static SentenceFormatter	UPPER_WHITE_SPACE Upper White Space formatter Example: Abc Def Ghi Words are translated to title case and are separated by white space character.

Constructor Summary

Constructors

Constructor and Description
SentenceFormatter(Function<String,String> convertFirstWord, String separator, Function<String,String> convertSubsequentWords) Creates a new SentenceFormatter instance.

Method Summary

Modifier and Type	Method and Description
String	format(List<String> words) Formats the list of given words using the specified converter functions and separator.
String	format(String... words) Formats the list of given words using the specified converter functions and separator.
Function<String,String>	getConvertFirstWord() Function to convert the first word
Function<String,String>	getConvertSubsequentWords() Function to convert all words except the first word
String	getSeparator() Separator character between words
List<String>	parse(String sentence) Splits the given sentence into words using the separator.

Methods inherited from class java.lang.Object

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

Field Detail

LOWER_CAMEL_CASE

public static final SentenceFormatter LOWER_CAMEL_CASE

Lower Camel Case formatter

Example: abcDefGhi

Words are translated to title case, except the first words, which is translated to lower case.

LOWER_KEBAB_CASE

public static final SentenceFormatter LOWER_KEBAB_CASE

Lower Kebab Case formatter

Example: abc-def-ghi

Words are translated to lower case and are separated by minus character.

LOWER_SNAKE_CASE

public static final SentenceFormatter LOWER_SNAKE_CASE

Lower Snake Case formatter

Example: abc_def_ghi

Words are translated to lower case and are separated by underscore character.

LOWER_WHITE_SPACE

public static final SentenceFormatter LOWER_WHITE_SPACE

Lower White Space formatter

Example: Abc def ghi

Words are translated to lower case, except the first word, which is translated to title case, and are separated by white space character.

UPPER_CAMEL_CASE

public static final SentenceFormatter UPPER_CAMEL_CASE

Upper Camel Case formatter

Example: AbcDefGhi

Words are translated to title case.

UPPER_KEBAB_CASE

public static final SentenceFormatter UPPER_KEBAB_CASE

Upper Kebab Case formatter

Example: ABC-DEF-GHI

Words are translated to upper case and are separated by minus character.

UPPER_SNAKE_CASE

public static final SentenceFormatter UPPER_SNAKE_CASE

Upper Snake Case formatter

Example: ABC_DEF_GHI

Words are translated to upper case and are separated by underscore character.

UPPER_WHITE_SPACE

public static final SentenceFormatter UPPER_WHITE_SPACE

Upper White Space formatter

Example: Abc Def Ghi

Words are translated to title case and are separated by white space character.

Constructor Detail

SentenceFormatter

public SentenceFormatter(Function<String,String> convertFirstWord,
                         String separator,
                         Function<String,String> convertSubsequentWords)

Creates a new SentenceFormatter instance.

Parameters:

convertFirstWord - Function to convert the first word

separator - Separator character between words

convertSubsequentWords - Function to convert all words except the first word

Method Detail

format

public String format(String... words)

Formats the list of given words using the specified converter functions and separator.

Parameters:

words - list of words

Returns:

formatted sentence

format

public String format(List<String> words)

Formats the list of given words using the specified converter functions and separator.

Parameters:

words - list of words

Returns:

formatted sentence

parse

public List<String> parse(String sentence)

Splits the given sentence into words using the separator. If the separator string is empty, the sentence is splitted by title characters. A leading title character does not generate an empty leading word.

Parameters:

sentence - the sentence to be splitted

Returns:

list of splitted words

getConvertFirstWord

public Function<String,String> getConvertFirstWord()

Function to convert the first word

Returns:

convert function for the first word of a sentence

getSeparator

public String getSeparator()

Separator character between words

Returns:

separator

getConvertSubsequentWords

public Function<String,String> getConvertSubsequentWords()

Function to convert all words except the first word

Returns:

convert function for subsequent words