de.ipcon.tools

Class L10nTimespanFormat

java.lang.Object

java.text.Format

de.ipcon.tools.L10nTimespanFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class L10nTimespanFormat
extends java.text.Format

L10nTimespanFormat basically supports three patternStr types/formats: 1. "colon" formats: 'HH:mm:ss.SSS' -> 126:39:44.000 'HH:mm:ss' -> 126:39:44 'HH:mm' -> 126:39 The hour part will always have at least two digits, but may have more if the value requires it. No rounding will take place for "higher granularity" formats, the millisecond, second or minutes parts respectively will simply be discarded. FIXME Formats with only at least one digit for the hour could be useful too sometimes. FIXME Provide the option to do rounding? 2. "one number" formats: '##0.00h' -> 126,66 '##0.00d' -> 5,28 The modifier at the end determines the granularity/precision of the result: Allowed are 's' for seconds, 'm' for minutes (60 seconds), 'h' for hours, 'd' for days, 'w' for weeks, 'M' for month (30 days), 'y' for years (365 days). The part before the modifier can be any valid DecimalFormat pattern string. '*' as modifier is also allowed and chooses the best granularity (that is the smallest one which results in a number >= 1.0) automatically. 3. The old legacy format: '' or null -> 1y 3M 5w 2d 11h 21m 54s See L10nTimespanFormatJunitTest for more examples. FIXME! handling of the formats is still partly rather lenient; if this is a feature or a bug is up to anyone's guess FIXME part of the code in this class could need some cleanup/optimization

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

java.text.Format.Field

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	charForToken
static long	dSecs
static long	hSecs
static long	mSecs
static long	MSecs
static java.lang.String	PATTERN_HHmm
static java.lang.String	PATTERN_HHmmss
static java.lang.String	PATTERN_HHmmssSSS
static java.lang.String	patternStrDefault
static long[]	secsForToken
static long	sSecs
static long	wSecs
static long	ySecs

Constructor Summary

Constructors

Constructor and Description
L10nTimespanFormat() Constructor.
L10nTimespanFormat(java.lang.String _patternStr)
L10nTimespanFormat(java.lang.String _patternStr, java.util.Locale _locale)

Method Summary

Modifier and Type	Method and Description
static javax.xml.datatype.Duration	durationFromTimespan(long _ms) Creates a Duration from a given number of milliseconds using the default factors of L10nTimespanFormat for the length of years, months, etc. for the calculation.
static int[]	factorsFromTimespan(long _ms)
java.lang.String	format(long _l) Convenience method to directly format a long.
java.lang.StringBuffer	format(java.lang.Object _obj, java.lang.StringBuffer _sb, java.text.FieldPosition _pos) Format _obj (Number) to String.
static javax.xml.datatype.DatatypeFactory	getDatatypeFactory()
java.util.Locale	getLocale()
java.lang.String	getPattern()
java.lang.Long	parse(java.lang.String _str) Convenience method to directly parse a String.
java.lang.Object	parseObject(java.lang.String _str, java.text.ParsePosition _pos) (Try to) parse _str into Object (Long).

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_HHmmssSSS

public static final java.lang.String PATTERN_HHmmssSSS

See Also:

Constant Field Values

PATTERN_HHmmss

public static final java.lang.String PATTERN_HHmmss

See Also:

Constant Field Values

PATTERN_HHmm

public static final java.lang.String PATTERN_HHmm

See Also:

Constant Field Values

patternStrDefault

public static final java.lang.String patternStrDefault

See Also:

Constant Field Values

sSecs

public static final long sSecs

See Also:

Constant Field Values

mSecs

public static final long mSecs

See Also:

Constant Field Values

hSecs

public static final long hSecs

See Also:

Constant Field Values

dSecs

public static final long dSecs

See Also:

Constant Field Values

wSecs

public static final long wSecs

See Also:

Constant Field Values

MSecs

public static final long MSecs

See Also:

Constant Field Values

ySecs

public static final long ySecs

See Also:

Constant Field Values

secsForToken

public static final long[] secsForToken

charForToken

public static final java.lang.String[] charForToken

Constructor Detail

L10nTimespanFormat

public L10nTimespanFormat()

Constructor.

L10nTimespanFormat

public L10nTimespanFormat(java.lang.String _patternStr)

L10nTimespanFormat

public L10nTimespanFormat(java.lang.String _patternStr,
                          java.util.Locale _locale)

Method Detail

getPattern

public java.lang.String getPattern()

getLocale

public java.util.Locale getLocale()

getDatatypeFactory

public static javax.xml.datatype.DatatypeFactory getDatatypeFactory()

format

public java.lang.String format(long _l)

Convenience method to directly format a long.

format

public java.lang.StringBuffer format(java.lang.Object _obj,
                                     java.lang.StringBuffer _sb,
                                     java.text.FieldPosition _pos)

Format _obj (Number) to String.

Specified by:

format in class java.text.Format

durationFromTimespan

public static javax.xml.datatype.Duration durationFromTimespan(long _ms)

Creates a Duration from a given number of milliseconds using the default factors of L10nTimespanFormat for the length of years, months, etc. for the calculation. Example: 86,400,000 milliseconds will always be translated to "one day" in the Duration, even though a day may last longer than that number of milliseconds in rare circumstances.

factorsFromTimespan

public static int[] factorsFromTimespan(long _ms)

parse

public java.lang.Long parse(java.lang.String _str)
                     throws java.text.ParseException

Convenience method to directly parse a String.

Throws:

java.text.ParseException

parseObject

public java.lang.Object parseObject(java.lang.String _str,
                                    java.text.ParsePosition _pos)

(Try to) parse _str into Object (Long). Returns a Long or null in case of a parse error.

Specified by:

parseObject in class java.text.Format