uk.co.strangeskies.text

Class CamelCaseFormatter

java.lang.Object

uk.co.strangeskies.text.CamelCaseFormatter

public class CamelCaseFormatter
extends java.lang.Object

A tool for formatting and unformatting series' of words to and from their camel case representation.

For the purposes of application of camel case rules, any code point which has no case is considered to be the same case as the preceding letter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CamelCaseFormatter.UnformattingCase Treatment of case when unformatting from camel case to separate words.

Constructor Summary

Constructors

Constructor and Description
CamelCaseFormatter() Construct a formatter which delimits over whitespace, which does not format camel case with a leading upper case character, and which unformats camel case with case preserved.
CamelCaseFormatter(java.lang.String delimiter, boolean leadingCapital, CamelCaseFormatter.UnformattingCase unformattingCase) Construct a formatter with the given settings.
CamelCaseFormatter(java.lang.String canonicalDelimiter, java.util.regex.Pattern delimiterPattern, boolean leadingCapital, CamelCaseFormatter.UnformattingCase unformattingCase) Construct a formatter with the given settings.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.lang.String words)
java.lang.String	getCanonicalDelimiter()
java.util.regex.Pattern	getDelimiterPattern()
CamelCaseFormatter.UnformattingCase	getUnformattingCase()
boolean	isLeadingCapital()
java.lang.String	join(java.util.List<java.lang.String> words)
java.util.List<java.lang.String>	split(java.lang.String string)
java.lang.String	unformat(java.lang.String string)

Methods inherited from class java.lang.Object

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

Constructor Detail

CamelCaseFormatter

public CamelCaseFormatter()

Construct a formatter which delimits over whitespace, which does not format camel case with a leading upper case character, and which unformats camel case with case preserved.

CamelCaseFormatter

public CamelCaseFormatter(java.lang.String delimiter,
                          boolean leadingCapital,
                          CamelCaseFormatter.UnformattingCase unformattingCase)

Construct a formatter with the given settings. Specifying an exact delimiter in this was gives faster formatting than a delimiter pattern.

Parameters:

delimiter - the delimiter string

leadingCapital - the leading capital setting

unformattingCase - the unformatting case strategy

CamelCaseFormatter

public CamelCaseFormatter(java.lang.String canonicalDelimiter,
                          java.util.regex.Pattern delimiterPattern,
                          boolean leadingCapital,
                          CamelCaseFormatter.UnformattingCase unformattingCase)

Construct a formatter with the given settings. The given canonical delimiter should match the given delimiter pattern

Parameters:

canonicalDelimiter - the canonical delimiter string

delimiterPattern - the delimiter pattern

leadingCapital - the leading capital setting

unformattingCase - the unformatting case strategy

Method Detail

getCanonicalDelimiter

public java.lang.String getCanonicalDelimiter()

Returns:

the canonical delimiter string for unformatting camel case strings

getDelimiterPattern

public java.util.regex.Pattern getDelimiterPattern()

Returns:

the delimiter pattern for formatting strings into camel case

isLeadingCapital

public boolean isLeadingCapital()

Returns:

true if camel case should lead with a capital letter, false otherwise

getUnformattingCase

public CamelCaseFormatter.UnformattingCase getUnformattingCase()

Returns:

the unformatting case strategy for this formatter

join

public java.lang.String join(java.util.List<java.lang.String> words)

Parameters:

words - a sequence of words in a list

Returns:

the given sequence of words in camel case format, with a leading capital if specified

split

public java.util.List<java.lang.String> split(java.lang.String string)

Parameters:

string - a string in camel case format

Returns:

the given camel case string split into words according to the unformatting case

format

public java.lang.String format(java.lang.String words)

Parameters:

words - a sequence of words separated by the delimiter pattern

Returns:

the given sequence of words in camel case format, with a leading capital if specified

unformat

public java.lang.String unformat(java.lang.String string)

Parameters:

string - a string in camel case format

Returns:

the given camel case string split into words according to the unformatting case, then joined about the delimiter string