com.ibm.icu.text

Class TimeUnitFormat

java.lang.Object

java.text.Format

com.ibm.icu.text.UFormat

com.ibm.icu.text.MeasureFormat

com.ibm.icu.text.TimeUnitFormat

All Implemented Interfaces:

Serializable, Cloneable

Deprecated.

ICU 53 use MeasureFormat instead.

@Deprecated
public class TimeUnitFormat
extends MeasureFormat

Format or parse a TimeUnitAmount, using plural rules for the units where available.

Code Sample:

   // create a time unit instance.
   // only SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, and YEAR are supported
   TimeUnit timeUnit = TimeUnit.SECOND;
   // create time unit amount instance - a combination of Number and time unit
   TimeUnitAmount source = new TimeUnitAmount(2, timeUnit);
   // create time unit format instance
   TimeUnitFormat format = new TimeUnitFormat();
   // set the locale of time unit format
   format.setLocale(new ULocale("en"));
   // format a time unit amount
   String formatted = format.format(source);
   System.out.println(formatted);
   try {
       // parse a string into time unit amount
       TimeUnitAmount result = (TimeUnitAmount) format.parseObject(formatted);
       // result should equal to source 
   } catch (ParseException e) {
   }
 

See Also:

TimeUnitAmount, MeasureFormat, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.icu.text.MeasureFormat

MeasureFormat.FormatWidth

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

Format.Field

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABBREVIATED_NAME Deprecated. ICU 53 see MeasureFormat.FormatWidth
static int	FULL_NAME Deprecated. ICU 53 see MeasureFormat.FormatWidth

Constructor Summary

Constructors

Constructor and Description
TimeUnitFormat() Deprecated. ICU 53 use MeasureFormat instead.
TimeUnitFormat(Locale locale) Deprecated. ICU 53 use MeasureFormat instead.
TimeUnitFormat(Locale locale, int style) Deprecated. ICU 53 use MeasureFormat instead.
TimeUnitFormat(ULocale locale) Deprecated. ICU 53 use MeasureFormat instead.
TimeUnitFormat(ULocale locale, int style) Deprecated. ICU 53 use MeasureFormat instead.

Method Summary

Modifier and Type	Method and Description
Object	clone() Deprecated. This API is ICU internal only.
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos) Deprecated. ICU 53 see MeasureFormat.
StringBuilder	formatMeasures(StringBuilder appendTo, FieldPosition fieldPosition, Measure... measures) Deprecated. This API is ICU internal only.
NumberFormat	getNumberFormat() Deprecated. This API is ICU internal only.
MeasureFormat.FormatWidth	getWidth() Deprecated. This API is ICU internal only.
TimeUnitAmount	parseObject(String source, ParsePosition pos) Deprecated. ICU 53 see MeasureFormat.
TimeUnitFormat	setLocale(Locale locale) Deprecated. ICU 53 see MeasureFormat.
TimeUnitFormat	setLocale(ULocale locale) Deprecated. ICU 53 see MeasureFormat.
TimeUnitFormat	setNumberFormat(NumberFormat format) Deprecated. ICU 53 see MeasureFormat.

Methods inherited from class com.ibm.icu.text.MeasureFormat

equals, formatMeasurePerUnit, formatMeasureRange, formatMeasures, getCurrencyFormat, getCurrencyFormat, getCurrencyFormat, getInstance, getInstance, getInstance, getInstance, getLocale, getRangeFormat, getRangePattern, hashCode

Methods inherited from class com.ibm.icu.text.UFormat

getLocale

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

FULL_NAME

@Deprecated
public static final int FULL_NAME

Deprecated. ICU 53 see MeasureFormat.FormatWidth

Constant for full name style format. For example, the full name for "hour" in English is "hour" or "hours".

See Also:

Constant Field Values

ABBREVIATED_NAME

@Deprecated
public static final int ABBREVIATED_NAME

Deprecated. ICU 53 see MeasureFormat.FormatWidth

Constant for abbreviated name style format. For example, the abbreviated name for "hour" in English is "hr" or "hrs".

See Also:

Constant Field Values

Constructor Detail

TimeUnitFormat

@Deprecated
public TimeUnitFormat()

Deprecated. ICU 53 use MeasureFormat instead.

Create empty format using full name style, for example, "hours". Use setLocale and/or setFormat to modify.

TimeUnitFormat

@Deprecated
public TimeUnitFormat(ULocale locale)

Deprecated. ICU 53 use MeasureFormat instead.

Create TimeUnitFormat given a ULocale, and using full name style.

Parameters:

locale - locale of this time unit formatter.

TimeUnitFormat

@Deprecated
public TimeUnitFormat(Locale locale)

Deprecated. ICU 53 use MeasureFormat instead.

Create TimeUnitFormat given a Locale, and using full name style.

Parameters:

locale - locale of this time unit formatter.

TimeUnitFormat

@Deprecated
public TimeUnitFormat(ULocale locale,
                                  int style)

Deprecated. ICU 53 use MeasureFormat instead.

Create TimeUnitFormat given a ULocale and a formatting style.

Parameters:

locale - locale of this time unit formatter.

style - format style, either FULL_NAME or ABBREVIATED_NAME style.

Throws:

IllegalArgumentException - if the style is not FULL_NAME or ABBREVIATED_NAME style.

TimeUnitFormat

@Deprecated
public TimeUnitFormat(Locale locale,
                                  int style)

Deprecated. ICU 53 use MeasureFormat instead.

Create TimeUnitFormat given a Locale and a formatting style.

Method Detail

setLocale

@Deprecated
public TimeUnitFormat setLocale(ULocale locale)

Deprecated. ICU 53 see MeasureFormat.

Set the locale used for formatting or parsing.

Parameters:

locale - locale of this time unit formatter.

Returns:

this, for chaining.

setLocale

@Deprecated
public TimeUnitFormat setLocale(Locale locale)

Deprecated. ICU 53 see MeasureFormat.

Set the locale used for formatting or parsing.

Parameters:

locale - locale of this time unit formatter.

Returns:

this, for chaining.

setNumberFormat

@Deprecated
public TimeUnitFormat setNumberFormat(NumberFormat format)

Deprecated. ICU 53 see MeasureFormat.

Set the format used for formatting or parsing. Passing null is equivalent to passing NumberFormat.getNumberInstance(ULocale).

Parameters:

format - the number formatter.

Returns:

this, for chaining.

format

@Deprecated
public StringBuffer format(Object obj,
                                       StringBuffer toAppendTo,
                                       FieldPosition pos)

Deprecated. ICU 53 see MeasureFormat.

Format a TimeUnitAmount.

Overrides:

format in class MeasureFormat

Parameters:

obj - must be a Collection, Measure[], or Measure object.

toAppendTo - Formatted string appended here.

pos - Identifies a field in the formatted text.

Returns:

the string buffer.

See Also:

Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)

parseObject

@Deprecated
public TimeUnitAmount parseObject(String source,
                                              ParsePosition pos)

Deprecated. ICU 53 see MeasureFormat.

Parse a TimeUnitAmount.

Overrides:

parseObject in class MeasureFormat

Parameters:

source - the string to parse.

pos - input/output parameter, specifies the start index in string from where to start parsing. If parsing is successful, it is updated with the index following the parsed text; on error, the index is unchanged and the error index is set to the index where the error occurred.

Returns:

the object resulting from the parse or null if there is an error.

See Also:

Format.parseObject(java.lang.String, java.text.ParsePosition)

formatMeasures

@Deprecated
public StringBuilder formatMeasures(StringBuilder appendTo,
                                                FieldPosition fieldPosition,
                                                Measure... measures)

Deprecated. This API is ICU internal only.

Description copied from class: MeasureFormat

Formats a sequence of measures. If the fieldPosition argument identifies a NumberFormat field, then its indices are set to the beginning and end of the first such field encountered. MeasureFormat itself does not supply any fields.

Overrides:

formatMeasures in class MeasureFormat

Parameters:

appendTo - the formatted string appended here.

fieldPosition - Identifies a field in the formatted text.

measures - the measures to format.

Returns:

appendTo.

See Also:

MeasureFormat.formatMeasures(Measure...)

getWidth

@Deprecated
public MeasureFormat.FormatWidth getWidth()

Deprecated. This API is ICU internal only.

Description copied from class: MeasureFormat

Get the format width this instance is using.

Overrides:

getWidth in class MeasureFormat

getNumberFormat

@Deprecated
public NumberFormat getNumberFormat()

Deprecated. This API is ICU internal only.

Description copied from class: MeasureFormat

Get a copy of the number format.

Overrides:

getNumberFormat in class MeasureFormat

clone

@Deprecated
public Object clone()

Deprecated. This API is ICU internal only.

Description copied from class: Format

Returns a copy of this Format instance.

Overrides:

clone in class Format

Returns:

a shallow copy of this format.

See Also:

Cloneable