net.mdatools.modelant.core.operation.format

Class FormatAbbreviated

java.lang.Object

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

net.mdatools.modelant.core.operation.format.FormatAbbreviated

All Implemented Interfaces:

Function<String,String>, Operation<String>

public class FormatAbbreviated
extends FormatWordsString

Convert a string to a constant name by:

1. Abbreviate each word in the name, except the last one to its first letter in upper case.
2. Add the whole last word to the abbreviated name, with first letter in upper case
3. Restrict the name up to length characters

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

Constructor and Description
FormatAbbreviated()

Method Summary

Modifier and Type	Method and Description
protected void	formatFirstWord(StringBuilder result, String word, boolean nextWordExists) Concatenate the formatted word into the result builder
protected void	formatNextWord(StringBuilder result, String word, boolean nextWordExists) Concatenate the formatted word into the result builder
protected String	prepare(String source) Implement any pre-processing of the source string, before parsing it into words

Methods inherited from class net.mdatools.modelant.core.operation.format.FormatWordsString

execute, formatFirstCapitalAllLower

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

FormatAbbreviated

public FormatAbbreviated()

Method Detail

prepare

protected final String prepare(String source)

Description copied from class: FormatWordsString

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

Specified by:

prepare in class FormatWordsString

Parameters:

source - the not-null string to format

Returns:

the sanitized string to parse into words

See Also:

FormatWordsString.prepare(java.lang.String)

formatFirstWord

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

Description copied from class: FormatWordsString

Concatenate the formatted word into the result builder

Specified by:

formatFirstWord in class FormatWordsString

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

See Also:

FormatWordsString.formatFirstWord(java.lang.StringBuilder, java.lang.String, boolean)

formatNextWord

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

Description copied from class: FormatWordsString

Concatenate the formatted word into the result builder

Specified by:

formatNextWord in class FormatWordsString

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

See Also:

FormatWordsString.formatNextWord(java.lang.StringBuilder, java.lang.String, boolean)