Humanize

Converts a given number to a string preceded by the corresponding binary International System of Units (SI) prefix.

Same as binaryPrefix(Number) for the specified locale.

Same as camelize(String) for the specified locale.

Makes a phrase camel case. Spaces, hyphens, underscores and dots will be removed.

Same as camelize(String, boolean) with capitalize to false.

Same as camelize(String, boolean) for the specified locale.

Same as capitalize(String) for the specified locale.

Capitalizes the given text smartly.

Returns a SimpleDateFormat instance for the current thread.

Date and Time Patterns

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.

The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's needed to separate two adjacent fields.
• Year: If the formatter's #getCalendar() Calendar is the Gregorian calendar, the following rules are applied.
  
  • For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.
  • For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.
  • For parsing with the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, as defined by isDigit(char), will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isn't all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.
  Otherwise, calendar system specific forms are applied. For both formatting and parsing, if the number of pattern letters is 4 or more, a calendar specific long form is used. Otherwise, a calendar specific short or abbreviated form is used.
• Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
• General time zone: Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:

       GMTOffsetTimeZone:
               GMT Sign Hours : Minutes
       Sign: one of
               + -
       Hours:
               Digit
               Digit Digit
       Minutes:
               Digit Digit
       Digit: one of
               0 1 2 3 4 5 6 7 8 9
   

  Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.

  For parsing, RFC 822 time zones are also accepted.

• RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit
   

  TwoDigitHours must be between 00 and 23. Other definitions are as for general time zones.

  For parsing, general time zones are also accepted.

Examples

Date and Time Pattern	Result
"yyyy.MM.dd G 'at' HH:mm:ss z"	2001.07.04 AD at 12:08:56 PDT
"EEE, MMM d, ''yy"	Wed, Jul 4, '01
"h:mm a"	12:08 PM
"hh 'o''clock' a, zzzz"	12 o'clock PM, Pacific Daylight Time
"K:mm a, z"	0:08 PM, PDT
"yyyyy.MMMMM.dd GGG hh:mm aaa"	02001.July.04 AD 12:08 PM
"EEE, d MMM yyyy HH:mm:ss Z"	Wed, 4 Jul 2001 12:08:56 -0700
"yyMMddHHmmssZ"	010704120856-0700
"yyyy-MM-dd'T'HH:mm:ss.SSSZ"	2001-07-04T12:08:56.235-0700

Same as dateFormat(String) for the specified locale.

Converts a camel case string into a human-readable name.

Example assuming SPACE as replacement:

Same as decamelize(String) defaulting to SPACE for replacement

Returns a DecimalFormat instance for the current thread.

Same as decimalFormat(String) for the specified locale.

Formats a number of seconds as hours, minutes and seconds.

Same as duration(Number, TimeStyle) for the specified locale.

Same as duration(Number) for the specified locale.

Formats a number of seconds as hours, minutes and seconds. Defaults to STANDARD time style.

Pads or truncates a string to a specified length.

Pads or truncates a string to a specified length.

Same as #format(String, Object...) for the specified locale.

Gets an ExtendedMessageFormat instance for the current thread with the given pattern and uses it to format a message with the specified arguments.

Same as formatCurrency(Number) for the specified locale.

Smartly formats the given number as a monetary amount.

For en_GB:

Formats a date according to the given pattern.

Same as formatDate(Date) for the specified locale.

Same as formatDate(int, Date) with SHORT style.

Formats the given date with the specified style.

Same as formatDate(Date, String) for the specified locale.

Same as formatDate(int, Date) for the specified locale.

Formats the given date/time with the specified styles.

Same as formatDateTime(int, int, Date) for the specified locale.

Same as formatDateTime(Date) for the specified locale.

Formats the given date/time with SHORT style.

Formats the given number to the standard decimal format for the default locale.

Same as formatDecimal(Number) for the specified locale.

Same as formatPercent(Number) for the specified locale.

Formats the given ratio as a percentage.

Same as lossyEquals(String, String) for the specified locale.

Locale-sensitive string comparison for primary differences.

 
 loosyEquals("Aáà-aa", "aaaaa") // == true 
 loosyEquals("abc", "cba") // == false
 
 

Formats the given text with the mask specified.

Returns a MaskFormat instance for the current thread.

Same as messageFormat(String) for the specified locale.

Returns a MessageFormat instance for the current thread.

Converts a given number to a string preceded by the corresponding decimal multiplicative prefix.

Same as metricPrefix(Number) for the specified locale.

Formats a number of nanoseconds as the proper ten power unit.

Same as nanoTime(Number) for the specified locale.

Same as naturalDay(int, Date) with the given locale.

Same as naturalDay(Date) with the given locale.

For dates that are the current day or within one day, return 'today', 'tomorrow' or 'yesterday', as appropriate. Otherwise, returns a string formatted according to a locale sensitive DateFormat.

Same as naturalDay(int, Date) with DateFormat.SHORT style.

Same as naturalTime(Date, long, Locale).

Same as naturalTime(Date, Date) for the specified locale.

Computes both past and future relative dates with arbitrary precision.

Same as naturalTime(Date, Date, long, Locale).

Same as naturalTime(Date, Date) with current date as reference.

Same as naturalTime(Date, long) for the specified locale.

Same as naturalTime(Date, long).

Computes both past and future relative dates.

E.g. 'one day ago', 'one day from now', '10 years ago', '3 minutes from now', 'right now' and so on.

Same as naturalTime(Date, Date, long) with current date as reference.

Same as naturalTime(Date) for the specified locale.

Same as naturalTime(Date, Date, long) for the specified locale.

Same as naturalTime(Date, Date, long).

Converts a number to its ordinal as a string.

E.g. 1 becomes '1st', 2 becomes '2nd', 3 becomes '3rd', etc.

Same as ordinal(Number) for the specified locale.

Same as oxford(Object[], int, String) for the specified locale.

Converts a list of items to a human readable string.

Converts a list of items to a human readable string with an optional limit.

Same as oxford(Object[]) for the specified locale.

Same as oxford(Object[]) for the specified locale.

Converts a list of items to a human readable string.

Converts a list of items to a human readable string with an optional limit.

Matches a pace (value and interval) with a logical time frame. Very useful for slow paces.

Examples:

 
   // 3 occurrences within a 3000ms interval
   pace(3, 3000); // => ~1/sec.
   
   // 200 occurrences within a 70000ms interval
   pace(200, 70000); // => ~3/sec.
   
   // 10 occurrences within a 70000ms interval
   pace(10, 70000); // => ~9/min.
   
   // 14 occurrences within a 31557600000ms interval (a year)
   pace(14, 31557600000L); // => ~1/month
   
   // 25 occurrences within a 31557600000ms interval
   pace(25, 31557600000L); // => ~2/month
   
   // 9 occurrences within a 31557600000ms interval
   pace(9, 31557600000L); // => >1/month (less than one per month)
 
 

Matches a pace (value and interval) with a logical time frame. Very useful for slow paces.

Matches a pace (value and interval) with a logical time frame. Very useful for slow paces. e.g. heartbeats, ingested calories, hyperglycemic crises.

Same as paceFormat(Number, long) for a target locale.

Same as paceFormat(Number, long, String, String, String) for a target locale.

Converts the string argument into an array of bytes.

Converts the string argumento into a Date value.

Converts the string argumento into a Date value.

Converts the string argumento into a Date value.

Same as #parseSmartDateWithSeparator(String, String, String...) but with "[\\D-_\\s]+" as the default separator.

 Date target = newDate(2012, 1, 1, 0, 0, 0);
 
 String dates[] = new String[] { "1.2.12", "01.02.2012", "2012.02.01", "01-02-12", "1 2 2012" };
 
 for (String ds : dates)
 {
     Date date = Humanize.parseSmartDate(ds, "dd/MM/yy", "yyyy/MM/dd", "dd/MM/yyyy");
     Assert.assertEquals(date, target);
 }
 

Tries to parse a date string applying an array of non lenient format patterns. The formats are automatically cached.

Same as #pluralize(String, String, Number, Object...) for the target locale.

Same as #pluralize(String, String, String, Number, Object...) for the target locale.

Applies the proper format for a given plural state.

 pluralize("There is one file on {1}.", "There are {0} files on {1}.", "There are no files on {1}.", 1, "disk");
 // == There is one file on disk.
 pluralize("There is one file on {1}.", "There are {0} files on {1}.", "There are no files on {1}.", 2, "disk");
 // == There are 2 files on disk.
 pluralize("There is one file on {1}.", "There are {0} files on {1}.", "There are no files on {1}.", 0, "disk");
 // == There are no files on disk.
 
 pluralize("one", "{0}", "none", 1);
 // = "one"
 pluralize("one", "{0}", "none", 2);
 // = "2"
 

Applies the proper format for a given plural state.

 pluralize("There is one file on {1}.", "There are {0} files on {1}.", 1, "disk");
 // == There is one file on disk.
 pluralize("There is one file on {1}.", "There are {0} files on {1}.", 2, "disk");
 // == There are 2 files on disk.
 

Same as pluralizeFormat(String) for the specified locale.

Constructs a message with pluralization logic by the means of ChoiceFormat.

Constructs a message with pluralization logic from the given template.

Examples:

 MessageFormat msg = pluralize("There {0} on {1}.::are no files::is one file::are {2} files");
 
 msg.render(0, "disk"); // == "There are no files on disk."
 msg.render(1, "disk"); // == "There is one file on disk."
 msg.render(1000, "disk"); // == "There are 1,000 files on disk."
 

 MessageFormat msg = pluralize("nothing::one thing::{0} things");
 
 msg.render(-1); // == "nothing"
 msg.render(0); // == "nothing"
 msg.render(1); // == "one thing"
 msg.render(2); // == "2 things"
 

 MessageFormat msg = pluralize("one thing::{0} things");
 
 msg.render(-1); // == "-1 things"
 msg.render(0); // == "0 things"
 msg.render(1); // == "one thing"
 msg.render(2); // == "2 things"
 

Returns a thread-safe PrettyTimeFormat instance.

Same as prettyTimeFormat() for the specified locale.

Replaces characters outside the Basic Multilingual Plane with their name.

Rounds a number to significant figures.

Sort of poor man's transliteration, i.e. normalizes and strips diacritical marks.

Transforms a text into a representation suitable to be used in an URL.

Converts a big number to a friendly text representation. Accepts values ranging from thousands to googols. Uses BigDecimal.

Same as spellBigNumber(Number) for the specified locale.

Same as spellDigit(Number) for the specified locale.

For decimal digits [0-9], returns the number spelled out. Otherwise, returns the number as string.

Same as times(Number) for the specified locale.

Interprets numbers as occurrences.

Converts the given text to title case smartly.

• Phrasal verb detection

Capitalize

• Nouns
• Verbs (including is and other forms of be)
• Participles
• Adverbs (including than and when)
• Adjectives (including this, that, and each)
• Pronouns (including its)
• Subordinating conjunctions (if, because, as, that)
• Prepositions and conjunctions with five or more letters (between, without, during, about, because, through)
• First and last words, no matter what part of speech they are
• Prepositions that are part of a verb phrase (Logging On, Setting Up)
• Both elements of hyphenated words (How-To, Country-Specific)
• Words and phrases in parentheses as you would capitalize them if they did not appear in parentheses
• Any words, phrases, fragments, or sentences after a colon or semicolon

Do Not Capitalize

• Coordinating conjunctions (and, but, or, nor, for)
• Prepositions of four or fewer letters (with, to, for, at, and so on)
• Articles (a, an, the, some) unless the article is the first or last word in the title
• The word to in an infinitive phrase
• Case-specific product names, words, or phrases (mySAP.com, README file, e-Business, and so on)

Converts the given text to title case smartly.

Makes a phrase underscored instead of spaced.

Parses the given text with the mask specified.

Truncate a string to the closest word boundary after a number of characters.