com.ibm.icu.text.DurationFormat Maven / Gradle / Ivy
Show all versions of icu4j Show documentation
/*
*******************************************************************************
* Copyright (C) 2007-2014, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.text;
import java.text.FieldPosition;
import java.text.ParsePosition;
import java.util.Date;
import com.ibm.icu.impl.duration.BasicDurationFormat;
import com.ibm.icu.util.ULocale;
/**
* This class implements a formatter over a duration in time
* such as "2 days from now" or "3 hours ago".
*
* @stable ICU 3.8
*/
public abstract class DurationFormat extends UFormat {
private static final long serialVersionUID = -2076961954727774282L;
/**
* Construct a duration format for the specified locale
* @stable ICU 3.8
*/
public static DurationFormat getInstance(ULocale locale) {
return BasicDurationFormat.getInstance(locale);
}
/**
* Subclass interface
* @internal
* @deprecated This API is ICU internal only.
*/
@Deprecated
protected DurationFormat() {
}
/**
* Subclass interface
* @internal
* @deprecated This API is ICU internal only.
*/
@Deprecated
protected DurationFormat(ULocale locale) {
setLocale(locale,locale);
}
/**
* Format an arbitrary object.
* Defaults to a call to formatDurationFromNow() for either Long or Date objects.
* @param object the object to format. Should be either a Long, Date, or javax.xml.datatype.Duration object.
* @param toAppend the buffer to append to
* @param pos the field position, may contain additional error messages.
* @return the toAppend buffer
* @stable ICU 3.8
*/
public abstract StringBuffer format(Object object, StringBuffer toAppend,
FieldPosition pos);
/**
* DurationFormat cannot parse, by default. This method will throw an UnsupportedOperationException.
* @stable ICU 3.8
*/
public Object parseObject(String source, ParsePosition pos) {
throw new UnsupportedOperationException();
}
/**
* Formats the duration between now and a target date.
*
* This is a convenience method that calls
* formatDurationFrom(long, long) using now
* as the reference date, and the difference between now and
* targetDate.getTime() as the duration.
*
* @param targetDate the ending date
* @return the formatted time
* @stable ICU 3.8
*/
public abstract String formatDurationFromNowTo(Date targetDate);
/**
* Formats a duration expressed in milliseconds.
*
* This is a convenience method that calls formatDurationFrom
* using the current system time as the reference date.
*
* @param duration the duration in milliseconds
* @return the formatted time
* @stable ICU 3.8
*/
public abstract String formatDurationFromNow(long duration);
/**
* Formats a duration expressed in milliseconds from a reference date.
*
* The reference date allows formatters to use actual durations of
* variable-length periods (like months) if they wish.
*
* The duration is expressed as the number of milliseconds in the
* past (negative values) or future (positive values) with respect
* to a reference date (expressed as milliseconds in epoch).
*
* @param duration the duration in milliseconds
* @param referenceDate the date from which to compute the duration
* @return the formatted time
* @stable ICU 3.8
*/
public abstract String formatDurationFrom(long duration, long referenceDate);
}