org.andromda.utils

Class StringUtilsHelper

java.lang.Object

org.apache.commons.lang.StringUtils

org.andromda.utils.StringUtilsHelper

public class StringUtilsHelper
extends org.apache.commons.lang.StringUtils

A utility object for doing string manipulation operations that are commonly needed by the code generation templates.

Author:

Matthias Bohlen, Chris Shaw, Chad Brandon, Wouter Zoons, Bob Fields

Field Summary

Fields inherited from class org.apache.commons.lang.StringUtils

EMPTY, INDEX_NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
StringUtilsHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static String	format(String plainText) Formats the argument string without any indentation, the text will be wrapped at the default column.
static String	format(String plainText, String indentation) Formats the given argument with the specified indentation, wrapping the text at a 64 column margin.
static String	format(String plainText, String indentation, int wrapAtColumn) Formats the given argument with the specified indentation, wrapping the text at the desired column margin.
static String	format(String plainText, String indentation, int wrapAtColumn, boolean htmlStyle) Formats the given argument with the specified indentation, wrapping the text at the desired column margin.
static String	getLineSeparator() Gets the line separator.
static String	lowerCamelCaseName(String string) Returns the argument string as a camel cased name beginning with a lowercased letter.
static String	pluralize(String singularNoun) Linguistically pluralizes a singular noun.
static String	prefixWithAPredicate(String word) Takes an English word as input and prefixes it with 'a ' or 'an ' depending on the first character of the argument String.
static String	removeLastOccurrence(String string, String value) Removes the last occurrence of the oldValue found within the string.
static String	replaceSuffix(String src, String suffixOld, String suffixNew) Replaces a given suffix of the source string with a new one.
static String	separate(String string, String separator) Converts the argument to lowercase, removes all non-word characters, and replaces each of those sequences by the separator.
static Boolean	startsWithLowercaseLetter(String string) Returns true if the input string starts with a lowercase letter.
static Boolean	startsWithUppercaseLetter(String string) Returns true if the input string starts with an uppercase letter.
static String	suffixLines(String multiLines, String suffix) Suffixes each line with the argument suffix.
static String	toPhrase(String string) Converts into a string suitable as a human readable phrase, First character is uppercase (the rest is left unchanged), words are separated by a space.
static String	toResourceMessage(String multiLines) Converts any multi-line String into a version that is suitable to be included as-is in properties resource bundle.
static String	toResourceMessageKey(String string) Converts the argument into a message key in a properties resource bundle, all lowercase characters, words are separated by dots.
static String	toSingleLine(String string) Converts multi-line text into a single line, normalizing whitespace in the process.
static String	upperCamelCaseName(String string) Returns the argument string as a camel cased name beginning with an uppercased letter.

Methods inherited from class org.apache.commons.lang.StringUtils

abbreviate, abbreviate, abbreviateMiddle, capitalise, capitaliseAllWords, capitalize, center, center, center, chomp, chomp, chompLast, chompLast, chop, chopNewline, clean, concatenate, contains, contains, containsAny, containsAny, containsIgnoreCase, containsNone, containsNone, containsOnly, containsOnly, countMatches, defaultIfBlank, defaultIfEmpty, defaultString, defaultString, deleteSpaces, deleteWhitespace, difference, endsWith, endsWithAny, endsWithIgnoreCase, equals, equalsIgnoreCase, escape, getChomp, getCommonPrefix, getLevenshteinDistance, getNestedString, getNestedString, getPrechomp, indexOf, indexOf, indexOf, indexOf, indexOfAny, indexOfAny, indexOfAny, indexOfAnyBut, indexOfAnyBut, indexOfDifference, indexOfDifference, indexOfIgnoreCase, indexOfIgnoreCase, isAllLowerCase, isAllUpperCase, isAlpha, isAlphanumeric, isAlphanumericSpace, isAlphaSpace, isAsciiPrintable, isBlank, isEmpty, isNotBlank, isNotEmpty, isNumeric, isNumericSpace, isWhitespace, join, join, join, join, join, join, join, join, join, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOfAny, lastIndexOfIgnoreCase, lastIndexOfIgnoreCase, lastOrdinalIndexOf, left, leftPad, leftPad, leftPad, length, lowerCase, lowerCase, mid, normalizeSpace, ordinalIndexOf, overlay, overlayString, prechomp, remove, remove, removeEnd, removeEndIgnoreCase, removeStart, removeStartIgnoreCase, repeat, repeat, replace, replace, replaceChars, replaceChars, replaceEach, replaceEachRepeatedly, replaceOnce, reverse, reverseDelimited, reverseDelimitedString, right, rightPad, rightPad, rightPad, split, split, split, split, splitByCharacterType, splitByCharacterTypeCamelCase, splitByWholeSeparator, splitByWholeSeparator, splitByWholeSeparatorPreserveAllTokens, splitByWholeSeparatorPreserveAllTokens, splitPreserveAllTokens, splitPreserveAllTokens, splitPreserveAllTokens, splitPreserveAllTokens, startsWith, startsWithAny, startsWithIgnoreCase, strip, strip, stripAll, stripAll, stripEnd, stripStart, stripToEmpty, stripToNull, substring, substring, substringAfter, substringAfterLast, substringBefore, substringBeforeLast, substringBetween, substringBetween, substringsBetween, swapCase, trim, trimToEmpty, trimToNull, uncapitalise, uncapitalize, upperCase, upperCase

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtilsHelper

public StringUtilsHelper()

Method Detail

replaceSuffix

public static String replaceSuffix(String src,
                   String suffixOld,
                   String suffixNew)

Replaces a given suffix of the source string with a new one. If the suffix isn't present, the string is returned unmodified.

Parameters:

src - the String for which the suffix should be replaced

suffixOld - a String with the suffix that should be replaced

suffixNew - a String with the new suffix

Returns:

a String with the given suffix replaced or unmodified if the suffix isn't present

upperCamelCaseName

public static String upperCamelCaseName(String string)

Returns the argument string as a camel cased name beginning with an uppercased letter.

Non word characters be removed and the letter following such a character will be uppercased.

Parameters:

string - any string

Returns:

the string converted to a camel cased name beginning with a lower cased letter.

removeLastOccurrence

public static String removeLastOccurrence(String string,
                          String value)

Removes the last occurrence of the oldValue found within the string.

Parameters:

string - the String to remove the value from.

value - the value to remove.

Returns:

String the resulting string.

lowerCamelCaseName

public static String lowerCamelCaseName(String string)

Returns the argument string as a camel cased name beginning with a lowercased letter.

Non word characters be removed and the letter following such a character will be uppercased.

Parameters:

string - any string

Returns:

the string converted to a camel cased name beginning with a lower cased letter.

startsWithLowercaseLetter

public static Boolean startsWithLowercaseLetter(String string)

Returns true if the input string starts with a lowercase letter. Used for validations of property/operation names against naming conventions.

Parameters:

string - any string

Returns:

true/false, null if null input

startsWithUppercaseLetter

public static Boolean startsWithUppercaseLetter(String string)

Returns true if the input string starts with an uppercase letter. Used for validations of Class names against naming conventions.

Parameters:

string - any string

Returns:

true/false, null if null input

toResourceMessageKey

public static String toResourceMessageKey(String string)

Converts the argument into a message key in a properties resource bundle, all lowercase characters, words are separated by dots.

Parameters:

string - any string

Returns:

the string converted to a value that would be well-suited for a message key

toPhrase

public static String toPhrase(String string)

Converts into a string suitable as a human readable phrase, First character is uppercase (the rest is left unchanged), words are separated by a space.

Parameters:

string - any string

Returns:

the string converted to a value that would be well-suited for a human readable phrase

separate

public static String separate(String string,
              String separator)

Converts the argument to lowercase, removes all non-word characters, and replaces each of those sequences by the separator.

Parameters:

string -

separator -

Returns:

separated string

suffixLines

public static String suffixLines(String multiLines,
                 String suffix)

Suffixes each line with the argument suffix.

Parameters:

multiLines - A String, optionally containing many lines

suffix - The suffix to append to the end of each line

Returns:

String The input String with the suffix appended at the end of each line

toResourceMessage

public static String toResourceMessage(String multiLines)

Converts any multi-line String into a version that is suitable to be included as-is in properties resource bundle.

Parameters:

multiLines - A String, optionally containing many lines

Returns:

String The input String with a backslash appended at the end of each line, or null if the input String was blank.

prefixWithAPredicate

public static String prefixWithAPredicate(String word)

Takes an English word as input and prefixes it with 'a ' or 'an ' depending on the first character of the argument String.

The characters 'a', 'e', 'i' and 'o' will yield the 'an' predicate while all the others will yield the 'a' predicate.

Parameters:

word - the word needing the predicate

Returns:

the argument prefixed with the predicate

toSingleLine

public static String toSingleLine(String string)

Converts multi-line text into a single line, normalizing whitespace in the process. This means whitespace characters will not follow each other directly. The resulting String will be trimmed. If the input String is null the return value will be an empty string.

Parameters:

string - A String, may be null

Returns:

The argument in a single line

pluralize

public static String pluralize(String singularNoun)

Linguistically pluralizes a singular noun.

• noun becomes nouns
• key becomes keys
• word becomes words
• property becomes properties
• bus becomes busses
• boss becomes bosses

Whitespace as well as null arguments will return an empty String.

Parameters:

singularNoun - A singular noun to pluralize

Returns:

The plural of the argument singularNoun or the empty String if the argument is null or blank.

format

public static String format(String plainText)

Formats the argument string without any indentation, the text will be wrapped at the default column.

Parameters:

plainText -

Returns:

formatted string

See Also:

format(String, String)

format

public static String format(String plainText,
            String indentation)

Formats the given argument with the specified indentation, wrapping the text at a 64 column margin.

Parameters:

plainText -

indentation -

Returns:

formatted string

See Also:

format(String, String, int)

format

public static String format(String plainText,
            String indentation,
            int wrapAtColumn)

Formats the given argument with the specified indentation, wrapping the text at the desired column margin. The returned String will not be suited for display in HTML environments.

Parameters:

plainText -

indentation -

wrapAtColumn -

Returns:

formatted string

See Also:

format(String, String, int, boolean)

format

public static String format(String plainText,
            String indentation,
            int wrapAtColumn,
            boolean htmlStyle)

Formats the given argument with the specified indentation, wrapping the text at the desired column margin.

When enabling htmlStyle the returned text will be suitable for display in HTML environments such as JavaDoc, all newlines will be replaced by paragraphs.

This method trims the input text: all leading and trailing whitespace will be removed.

If for some reason this method would fail it will return the plainText argument.

Parameters:

plainText - the text to format, the empty string will be returned in case this argument is null; long words will be placed on a newline but will never be wrapped

indentation - the empty string will be used if this argument would be null

wrapAtColumn - does not take into account the length of the indentation, needs to be strictly positive

htmlStyle - whether or not to make sure the returned string is suited for display in HTML environments such as JavaDoc

Returns:

a String instance which represents the formatted input, never null

Throws:

IllegalArgumentException - when the wrapAtColumn argument is not strictly positive

getLineSeparator

public static String getLineSeparator()

Gets the line separator.

Returns:

the line separator.