org.apache.commons.scaffold.text
Class ConvertUtils

java.lang.Object
  org.apache.commons.scaffold.text.ConvertUtils

public class ConvertUtils

extends java.lang.Object

An experimental class with some standard conversion utilities. Needs more proof of concept and unit testing.

Version:

$Revision: 1.11 $ $Date: 2004/03/21 21:10:18 $

Field Summary

static char	CARRIAGE_RETURN Carriage return character.
static java.lang.String	CURRENCY_PATTERN Standard currency pattern.
static java.lang.String	DATE_SEPARATOR Date separator ["-"].
static java.lang.String	DATE_TIME_SEPARATOR Date Time separator [" "].
static java.lang.String	DECIMAL_PATTERN Default decimal pattern.
static int	DEFAULT Default style for dates and times.
static java.lang.Double	DOUBLE_ONE An Double 1.
static java.lang.Double	DOUBLE_ZERO An Double 0.
static java.lang.String	EMPTY_STRING Deprecated. Use STRING_EMPTY
static java.lang.String	ESCAPE_DATE_PATTERN A "default" date format.
static char	FILE_SEPARATOR File separator character.
static char	FORM_FEED Form feed character.
static int	FULL Full style for dates and times.
static char	GROUP_SEPARATOR Group separator character.
static char	HORIZONTAL_TABULATION Horizontal tab character.
static java.lang.Integer	INTEGER_ONE An Integer 1.
static java.lang.Integer	INTEGER_ZERO An Integer 0.
static char	LINE_FEED Line feed character.
static int	LONG Long style for dates and times.
static java.sql.Timestamp	MAX_TIMESTAMP Timestamp representing "December 31, 2029, 23:59:59.9"
static int	MEDIUM Medium style for dates and times.
static long	NULL_TIME Value needed to create Timestamp representing "January 1, 1970 00:00:00".
static java.sql.Timestamp	NULL_TIMESTAMP Timestamp representing "January 1, 1970 00:00:00".
static java.lang.String	NULL_TIMESTAMP_DISPLAY Escape string to create Timestamp representing "January 1, 1970 00:00:00".
static java.lang.String	NULL_TIMESTAMP_TEXT Deprecated. Use NULL_TIMESTAMP_DISPLAY.
static java.lang.String	QS_DELIM The token that delimits two or more attributes of a query string ["&"].
static java.lang.String	QS_SEP The token that seperates an attribute name and value.
static java.lang.String	QS_START The token that signifies the begnning of a query string ["?"].
static char	RECORD_SEPARATOR Record separator character.
static char[]	SEPARATORS Array of line separator characters.
static int	SHORT Short style for dates and times.
static java.lang.Short	SHORT_ONE A Short 1.
static java.lang.Short	SHORT_ZERO A Short 0.
static char	SPACE Space character.
static java.lang.String	STRING_EMPTY An empty string.
static java.lang.String	STRING_ONE A String 1.
static java.lang.String	STRING_SPACE An single-space string.
static java.lang.String	STRING_ZERO A String 0.
static java.lang.String	TIME_SEPARATOR Time separator [":"].
static java.lang.String	TIMESTAMP_DATE_ZERO String to prepend to time [HH:MM:SS.d] to create a Timestamp escape string ["0002-11-30"].
static java.lang.String	TIMESTAMP_TIME_ZERO String to append to date [YEAR-MM-DD] to create a Timestamp escape string [" 00:00:00.0"].
static char	UNIT_SEPARATOR Unit separator character.
static char	VERTICAL_TABULATION Vertical tab character.
static java.sql.Timestamp	ZERO_TIMESTAMP Timestamp representing ""November 30, 0002 00:00:00".
static java.lang.String	ZERO_TIMESTAMP_DISPLAY Escape string representing "November 30, 0002 00:00:00".

Method Summary

static java.lang.String	addLuhnDigit(java.lang.String number) Returns number with the appropriate digit appended so that is passes a "luhnCheck".
static java.lang.String	addParam(java.lang.String path, java.lang.String name, java.lang.String value) Appends name=value parameter.
static java.lang.String	addParams(java.lang.String path, java.util.Map parameters) Appends name=value parameters to path from Map.
static boolean	blank(java.lang.Number key) Deprecated. Use blank instead.
static boolean	blank(java.lang.String s) Deprecated. Use blank instead.
static boolean	blankValue(java.lang.String s) Returns true if null, trims to an empty string, or to "0".
static java.lang.String	getCurrency(java.lang.Number value) Return currency for default locale using standard pattern.
static java.lang.String	getDate(java.util.Date date) Convert date to String for default locale in DEFAULT style.
static java.lang.String	getDate(java.util.Date date, int style) Convert date to String for default locale in given style.
static java.lang.String	getDate(java.util.Date date, java.util.Locale locale, int style) Convert date to String for given locale in given style.
static java.util.Date	getDate(java.lang.String dateDisplay) Convert String to Date using a medium (weekday day month year) format.
static java.util.Date	getDate(java.lang.String dateDisplay, java.lang.String format) Convert String to Date using given format.
static java.util.Date	getDate(java.lang.String dateDisplay, java.lang.String format, boolean lenient) Convert String to Date using given format.
static java.lang.String	getDecimal(java.lang.Number value) Return decimal for default locale using standard pattern.
static java.lang.String	getDecimal(java.lang.Number value, java.util.Locale locale) Return decimal number formatted for default or given locale.
static java.lang.String	getDecimal(java.lang.Number value, java.util.Locale locale, java.lang.String pattern) Return decimal number formatted for default or given locale using given pattern.
static java.lang.String	getDigits(java.lang.String s) Return String with of digits only (0..9).
static java.text.DecimalFormatSymbols	getGenericDecimal(java.util.Locale locale) Symbols that can be used in a decimal pattern.
static java.lang.String	getNumber(java.lang.Number value, java.util.Locale locale) Returns number formatted for default or given locale.
static java.lang.String	getPercent(java.lang.Number value, java.util.Locale locale) Returns percent formatted for default or given locale.
static java.sql.Timestamp	getTimestamp() Factory method to return timestamp initialized to current system time.
static java.lang.String	getTimestamp(java.sql.Timestamp timestamp) Convert date to String for default locale in DEFAULT style.
static java.lang.String	getTimestamp(java.sql.Timestamp timestamp, int style) Convert date to String for default locale in given style.
static java.lang.String	getTimestamp(java.sql.Timestamp timestamp, java.util.Locale locale, int style) Convert timestamp to String for given locale in given style.
static java.lang.String	getTimestampDisplay() Return the String representing the current timestamp;
static java.lang.String	getTimestampDisplayNull() Return the String representing "January 1, 1970 00:00:00".
static java.lang.String	getTimestampText() Deprecated. Use getTimestampDisplay.
static java.lang.Integer	ipNode(java.lang.String ipAddress) Return the integer value of an IP address in dotted octet form, like that returned by request.getRemotehost).
static boolean	isBlank(java.lang.Integer key) Deprecated. Use blank instead.
static boolean	isBlank(java.lang.String s) Deprecated. Use blank instead.
static boolean	isBlankValue(java.lang.String s) Deprecated. Use blankValue instead.
static boolean	isNull(java.sql.Timestamp timestamp) Return null if timestamp is null or equals "January 1, 1970 00:00:00".
static boolean	luhnCheck(java.lang.String number)
static java.lang.String	renderHiddenFields(java.util.Map parameters) Returns parameters as a series of hidden HTML fields.
static java.util.Date	toDate(java.lang.String string) Return Date value using a String.
static java.lang.String	toEscape(java.util.Date date) Return String value representing Date.
static java.lang.String[]	tokensToArray(java.lang.String tokens, java.lang.String separator) Return array of tokens, using the result of getTokeSep() as the separator.
static java.util.List	tokensToList(java.lang.String tokens, java.lang.String separator) Return list of tokens, using the result of getTokeSep() as the separator.
static java.lang.String	toString(java.util.Date date) Return String value representing Date.
static java.lang.String	toString(java.sql.Timestamp timestamp) Return String value representing Timestamp.
static java.sql.Timestamp	toTimestamp(java.lang.String string) Return Timestamp value using a String.
static java.sql.Timestamp	toTimestamp(java.lang.String year, java.lang.String month, java.lang.String day) Return a Timestamp based on the parameters.
static java.lang.String	toTrimOrEmpty(java.lang.String string) Return a trimmed or empty string (but not null).
static java.lang.String	toUpperOrNull(java.lang.String string) Returns null or a trimmed uppercase string.

Methods inherited from class java.lang.Object

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

Field Detail

STRING_EMPTY

public static java.lang.String STRING_EMPTY

An empty string.

EMPTY_STRING

public static java.lang.String EMPTY_STRING

Deprecated. Use STRING_EMPTY

An empty string.

STRING_SPACE

public static final java.lang.String STRING_SPACE

An single-space string.

See Also:

Constant Field Values

SPACE

public static final char SPACE

Space character.

See Also:

Constant Field Values

HORIZONTAL_TABULATION

public static final char HORIZONTAL_TABULATION

Horizontal tab character.

See Also:

Constant Field Values

LINE_FEED

public static final char LINE_FEED

Line feed character.

See Also:

Constant Field Values

VERTICAL_TABULATION

public static final char VERTICAL_TABULATION

Vertical tab character.

See Also:

Constant Field Values

FORM_FEED

public static final char FORM_FEED

Form feed character.

See Also:

Constant Field Values

CARRIAGE_RETURN

public static final char CARRIAGE_RETURN

Carriage return character.

See Also:

Constant Field Values

FILE_SEPARATOR

public static final char FILE_SEPARATOR

File separator character.

See Also:

Constant Field Values

GROUP_SEPARATOR

public static final char GROUP_SEPARATOR

Group separator character.

See Also:

Constant Field Values

RECORD_SEPARATOR

public static final char RECORD_SEPARATOR

Record separator character.

See Also:

Constant Field Values

UNIT_SEPARATOR

public static final char UNIT_SEPARATOR

Unit separator character.

See Also:

Constant Field Values

SEPARATORS

public static final char[] SEPARATORS

Array of line separator characters. http://java.sun.com/j2se/1.3/docs/api/java/lang/Character.html#isWhitespace(char)

QS_START

public static java.lang.String QS_START

The token that signifies the begnning of a query string ["?"].

QS_DELIM

public static java.lang.String QS_DELIM

The token that delimits two or more attributes of a query string ["&"].

QS_SEP

public static java.lang.String QS_SEP

The token that seperates an attribute name and value.

DOUBLE_ZERO

public static java.lang.Double DOUBLE_ZERO

An Double 0.

DOUBLE_ONE

public static java.lang.Double DOUBLE_ONE

An Double 1.

INTEGER_ZERO

public static java.lang.Integer INTEGER_ZERO

An Integer 0.

INTEGER_ONE

public static java.lang.Integer INTEGER_ONE

An Integer 1.

SHORT_ZERO

public static java.lang.Short SHORT_ZERO

A Short 0.

SHORT_ONE

public static java.lang.Short SHORT_ONE

A Short 1.

STRING_ZERO

public static java.lang.String STRING_ZERO

A String 0.

STRING_ONE

public static java.lang.String STRING_ONE

A String 1.

DECIMAL_PATTERN

public static java.lang.String DECIMAL_PATTERN

Default decimal pattern. http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html

CURRENCY_PATTERN

public static java.lang.String CURRENCY_PATTERN

Standard currency pattern. http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html

DEFAULT

public static int DEFAULT

Default style for dates and times.

SHORT

public static int SHORT

Short style for dates and times.

MEDIUM

public static int MEDIUM

Medium style for dates and times.

LONG

public static int LONG

Long style for dates and times.

FULL

public static int FULL

Full style for dates and times.

ESCAPE_DATE_PATTERN

public static java.lang.String ESCAPE_DATE_PATTERN

A "default" date format.

DATE_SEPARATOR

public static final java.lang.String DATE_SEPARATOR

Date separator ["-"].

See Also:

Constant Field Values

TIME_SEPARATOR

public static final java.lang.String TIME_SEPARATOR

Time separator [":"].

See Also:

Constant Field Values

DATE_TIME_SEPARATOR

public static final java.lang.String DATE_TIME_SEPARATOR

Date Time separator [" "].

See Also:

Constant Field Values

TIMESTAMP_DATE_ZERO

public static final java.lang.String TIMESTAMP_DATE_ZERO

String to prepend to time [HH:MM:SS.d] to create a Timestamp escape string ["0002-11-30"].

See Also:

Constant Field Values

TIMESTAMP_TIME_ZERO

public static final java.lang.String TIMESTAMP_TIME_ZERO

String to append to date [YEAR-MM-DD] to create a Timestamp escape string [" 00:00:00.0"]. Note: includes leading space.

See Also:

Constant Field Values

ZERO_TIMESTAMP_DISPLAY

public static java.lang.String ZERO_TIMESTAMP_DISPLAY

Escape string representing "November 30, 0002 00:00:00".

ZERO_TIMESTAMP

public static java.sql.Timestamp ZERO_TIMESTAMP

Timestamp representing ""November 30, 0002 00:00:00".

NULL_TIMESTAMP_DISPLAY

public static java.lang.String NULL_TIMESTAMP_DISPLAY

Escape string to create Timestamp representing "January 1, 1970 00:00:00".

NULL_TIMESTAMP_TEXT

public static java.lang.String NULL_TIMESTAMP_TEXT

Deprecated. Use NULL_TIMESTAMP_DISPLAY.

NULL_TIME

public static long NULL_TIME

Value needed to create Timestamp representing "January 1, 1970 00:00:00". From the documentation, you would think this would be Timestamp(0), but empirical tests show it to be Timestamp(18000000).

NULL_TIMESTAMP

public static java.sql.Timestamp NULL_TIMESTAMP

Timestamp representing "January 1, 1970 00:00:00".

MAX_TIMESTAMP

public static java.sql.Timestamp MAX_TIMESTAMP

Timestamp representing "December 31, 2029, 23:59:59.9"

Method Detail

tokensToArray

public static java.lang.String[] tokensToArray(java.lang.String tokens,
                                               java.lang.String separator)

Return array of tokens, using the result of getTokeSep() as the separator. Blanks are trimmed from tokens.

tokensToList

public static java.util.List tokensToList(java.lang.String tokens,
                                          java.lang.String separator)

Return list of tokens, using the result of getTokeSep() as the separator. Blanks are trimmed from tokens.

isBlank

public static boolean isBlank(java.lang.String s)

Deprecated. Use blank instead.

Returns true if null or trims to an empty string.

isBlank

public static boolean isBlank(java.lang.Integer key)

Deprecated. Use blank instead.

Returns true if null or zero.

isBlankValue

public static boolean isBlankValue(java.lang.String s)

Deprecated. Use blankValue instead.

Returns true if null or trims to an empty string.

blank

public static boolean blank(java.lang.String s)

Deprecated. Use blank instead.

Returns true if null or trims to an empty string.

blank

public static boolean blank(java.lang.Number key)

Deprecated. Use blank instead.

Returns true if null or zero.

blankValue

public static boolean blankValue(java.lang.String s)

Returns true if null, trims to an empty string, or to "0".

toTrimOrEmpty

public static java.lang.String toTrimOrEmpty(java.lang.String string)

Return a trimmed or empty string (but not null).

toUpperOrNull

public static java.lang.String toUpperOrNull(java.lang.String string)

Returns null or a trimmed uppercase string.

addParam

public static java.lang.String addParam(java.lang.String path,
                                        java.lang.String name,
                                        java.lang.String value)

Appends name=value parameter.

addParams

public static java.lang.String addParams(java.lang.String path,
                                         java.util.Map parameters)

Appends name=value parameters to path from Map.

renderHiddenFields

public static java.lang.String renderHiddenFields(java.util.Map parameters)

Returns parameters as a series of hidden HTML fields.

getDigits

public static java.lang.String getDigits(java.lang.String s)

Return String with of digits only (0..9). http://java.sun.com/j2se/1.4/docs/api/java/lang/Character.html

getNumber

public static java.lang.String getNumber(java.lang.Number value,
                                         java.util.Locale locale)

Returns number formatted for default or given locale.

getPercent

public static java.lang.String getPercent(java.lang.Number value,
                                          java.util.Locale locale)

Returns percent formatted for default or given locale.

luhnCheck

public static boolean luhnCheck(java.lang.String number)

addLuhnDigit

public static java.lang.String addLuhnDigit(java.lang.String number)

Returns number with the appropriate digit appended so that is passes a "luhnCheck".

getGenericDecimal

public static java.text.DecimalFormatSymbols getGenericDecimal(java.util.Locale locale)

Symbols that can be used in a decimal pattern.

getDecimal

public static java.lang.String getDecimal(java.lang.Number value,
                                          java.util.Locale locale)

Return decimal number formatted for default or given locale.

getDecimal

public static java.lang.String getDecimal(java.lang.Number value,
                                          java.util.Locale locale,
                                          java.lang.String pattern)

Return decimal number formatted for default or given locale using given pattern.

getDecimal

public static java.lang.String getDecimal(java.lang.Number value)

Return decimal for default locale using standard pattern.

getCurrency

public static java.lang.String getCurrency(java.lang.Number value)

Return currency for default locale using standard pattern.

getDate

public static java.util.Date getDate(java.lang.String dateDisplay,
                                     java.lang.String format,
                                     boolean lenient)

Convert String to Date using given format. Returns null if conversion fails. Set lenient=false to disallow dates like 2001-9-32. http://java.sun.com/j2se/1.4/docs/api/java/text/SimpleDateFormat.html

getDate

public static java.util.Date getDate(java.lang.String dateDisplay,
                                     java.lang.String format)

Convert String to Date using given format. Returns null if conversion fails. Uses "strict" coNversion (lenient=false).

getDate

public static java.util.Date getDate(java.lang.String dateDisplay)

Convert String to Date using a medium (weekday day month year) format. Returns null if conversion fails. Uses "strict" coNversion (lenient=false).

toDate

public static java.util.Date toDate(java.lang.String string)

Return Date value using a String. Null or conversion error returns null.

getDate

public static java.lang.String getDate(java.util.Date date,
                                       java.util.Locale locale,
                                       int style)

Convert date to String for given locale in given style. A null locale will return the default locale.

getDate

public static java.lang.String getDate(java.util.Date date,
                                       int style)

Convert date to String for default locale in given style. A null locale will return the default locale.

getDate

public static java.lang.String getDate(java.util.Date date)

Convert date to String for default locale in DEFAULT style. A null locale will return the default locale.

toString

public static java.lang.String toString(java.util.Date date)

Return String value representing Date. Null returns null.

toEscape

public static java.lang.String toEscape(java.util.Date date)

Return String value representing Date. Null returns null.

getTimestampDisplayNull

public static java.lang.String getTimestampDisplayNull()

Return the String representing "January 1, 1970 00:00:00".

getTimestampDisplay

public static java.lang.String getTimestampDisplay()

Return the String representing the current timestamp;

getTimestampText

public static java.lang.String getTimestampText()

Deprecated. Use getTimestampDisplay.

isNull

public static boolean isNull(java.sql.Timestamp timestamp)

Return null if timestamp is null or equals "January 1, 1970 00:00:00".

getTimestamp

public static java.sql.Timestamp getTimestamp()

Factory method to return timestamp initialized to current system time. For timestamp as a String in the default format, use getTimestamp().toString().

getTimestamp

public static java.lang.String getTimestamp(java.sql.Timestamp timestamp,
                                            java.util.Locale locale,
                                            int style)

Convert timestamp to String for given locale in given style. A null locale will return the default locale.

getTimestamp

public static java.lang.String getTimestamp(java.sql.Timestamp timestamp,
                                            int style)

Convert date to String for default locale in given style. A null locale will return the default locale.

getTimestamp

public static java.lang.String getTimestamp(java.sql.Timestamp timestamp)

Convert date to String for default locale in DEFAULT style. A null locale will return the default locale.

toTimestamp

public static java.sql.Timestamp toTimestamp(java.lang.String string)

Return Timestamp value using a String. Null or conversion error returns null.

toTimestamp

public static java.sql.Timestamp toTimestamp(java.lang.String year,
                                             java.lang.String month,
                                             java.lang.String day)

Return a Timestamp based on the parameters. Any nulls or conversion error returns null.

Parameters:

year - The year

month - The month

day - The day

toString

public static java.lang.String toString(java.sql.Timestamp timestamp)

Return String value representing Timestamp. Null returns null.

ipNode

public static java.lang.Integer ipNode(java.lang.String ipAddress)

Return the integer value of an IP address in dotted octet form, like that returned by request.getRemotehost). :FIXME: Needs to be implemented; just returns zero.