net.zer0bandwidth.android.lib.text.format

Class TitleFormatter

java.lang.Object

net.zer0bandwidth.android.lib.text.format.TitleFormatter

public class TitleFormatter
extends java.lang.Object

Formats a string as a title. The class currently supports only an English locale, but other locale supports may be added in the future.

Since:

zer0bandwidth-net/android 0.1.5 (#11)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TitleFormatter.EnglishLocaleContext A data structure which self-initializes with all the data related to evaluations in an English-speaking context.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(android.content.Context ctx, java.lang.String sInput) Formats a string as a title.
static java.lang.String	format(android.content.Context ctx, java.lang.String sInput, java.util.Locale loc) Formats a string as a title, using the specified locale (eventually...).
protected static java.lang.String	formatEnglishTitle(android.content.Context ctx, java.lang.String sInput) Formats a string as a title, assuming an English-speaking locale.
protected static java.lang.String	resolveEnglishToken(TitleFormatter.EnglishLocaleContext lctx, java.lang.String sToken, boolean bForce) Resolves capitalization of a single English token.

Methods inherited from class java.lang.Object

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

Method Detail

format

public static java.lang.String format(android.content.Context ctx,
                                      java.lang.String sInput)

Formats a string as a title.

Parameters:

ctx - a context, so we can fetch localized string resources

sInput - the input string

Returns:

a new string, formatted as a title

format

public static java.lang.String format(android.content.Context ctx,
                                      java.lang.String sInput,
                                      java.util.Locale loc)

Formats a string as a title, using the specified locale (eventually...).

Parameters:

ctx - a context, so we can fetch localized string resources

sInput - the input string

loc - the locale to be considered; this is currently ignored, but may be used in a future version

Returns:

a new string, formatted as a title

formatEnglishTitle

protected static java.lang.String formatEnglishTitle(android.content.Context ctx,
                                                     java.lang.String sInput)

Formats a string as a title, assuming an English-speaking locale.

The criteria used are as follows:

• Capitalize the first and last word.
• Capitalize any word that is not an article, conjunction, or preposition shorter than five letters.

This most closely matches the AP Stylebook, as opposed to the Chicago Manual of Style or the MLA guidelines.

Parameters:

sInput - the input string

Returns:

a new string, formatted as a title

See Also:

Your Dictionary: Rules for Capitalization in Titles of Articles

resolveEnglishToken

protected static java.lang.String resolveEnglishToken(TitleFormatter.EnglishLocaleContext lctx,
                                                      java.lang.String sToken,
                                                      boolean bForce)

Resolves capitalization of a single English token.

Parameters:

lctx - contextual information about English-speaking locales

sToken - the input token

bForce - specifies that capitalization should be forced

Returns:

the resolved token