net.mdatools.modelant.core.operation.format

Class FormatWordsString

java.lang.Object

net.mdatools.modelant.core.operation.format.FormatWordsString

All Implemented Interfaces:

Function<String,String>, Operation<String>

Direct Known Subclasses:

FormatAbbreviated, FormatAllCapital, FormatAllLower, FormatFirstCapital, FormatFirstLower, FormatHumanReadable, FormatPackageName

public abstract class FormatWordsString
extends Object
implements Operation<String>

Extract the words from the string, format them ad concatenate them according

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields inherited from interface net.mdatools.modelant.core.api.Operation

DEFAULT

Fields inherited from interface net.mdatools.modelant.core.api.Function

IDENTITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatWordsString(String separator)

Method Summary

Modifier and Type	Method and Description
String	execute(String source)
protected void	formatFirstCapitalAllLower(StringBuilder result, String name) Append to result the string provided, with first letter capitalized and all next in lower case
protected abstract void	formatFirstWord(StringBuilder result, String word, boolean nextWordExists) Concatenate the formatted word into the result builder
protected abstract void	formatNextWord(StringBuilder result, String word, boolean nextWordExists) Concatenate the formatted word into the result builder
protected abstract String	prepare(String source) Implement any pre-processing of the source string, before parsing it into words

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.api.Function

toString

Constructor Detail

FormatWordsString

protected FormatWordsString(String separator)

Parameters:

separator - not null, possibly empty string to use as a separator between the result words

Method Detail

execute

public final String execute(String source)
                     throws RuntimeException,
                            IllegalArgumentException

Specified by:

execute in interface Function<String,String>

Parameters:

source - not null string to parse

Returns:

string of the formatted words from the source string, concatenated with the separator string provided

Throws:

RuntimeException

IllegalArgumentException

See Also:

Function.execute(java.lang.Object)

prepare

protected abstract String prepare(String source)

Implement any pre-processing of the source string, before parsing it into words

Parameters:

source - the not-null string to format

Returns:

the sanitized string to parse into words

formatFirstWord

protected abstract void formatFirstWord(StringBuilder result,
                                        String word,
                                        boolean nextWordExists)

Concatenate the formatted word into the result builder

Parameters:

result - non null store of the produced word, result.lenght() = 0

word - not null, not empty word of letters and digits, which is NOT the first word identified in the source string

nextWordExists - true, if there are more words to be formatted, false when this is the only word to format

formatNextWord

protected abstract void formatNextWord(StringBuilder result,
                                       String word,
                                       boolean nextWordExists)

Concatenate the formatted word into the result builder

Parameters:

result - non null store of the produced word, result.lenght() != 0

word - not null, not empty word of letters and digits, which is the first word identified in the source string

nextWordExists - true, if there are more words to be formatted, false when this is the last word to format

formatFirstCapitalAllLower

protected final void formatFirstCapitalAllLower(StringBuilder result,
                                                String name)

Append to result the string provided, with first letter capitalized and all next in lower case

Parameters:

name - not null to capitalize

result - not null result/output parameter