rbnf(new RuleBasedNumberFormat(URBNF_SPELLOUT, "en-us", status));
+ RelativeDateTimeFormatter fmt("en-us", rbnf.orphan(), status);
+ UnicodeString result;
+ assertEquals("format (direction)", "in five seconds",
+ fmt.format(5, UDAT_DIRECTION_NEXT, UDAT_RELATIVE_SECONDS, result, status));
+ assertEquals("formatNumeric", "one week ago",
+ fmt.formatNumeric(-1, UDAT_REL_UNIT_WEEK, result.remove(), status));
+ assertEquals("format (absolute)", "yesterday",
+ fmt.format(UDAT_DIRECTION_LAST, UDAT_ABSOLUTE_DAY, result.remove(), status));
+ assertEquals("format (relative)", "in forty-two months",
+ fmt.format(42, UDAT_REL_UNIT_MONTH, result.remove(), status));
+
+ {
+ const char16_t* message = u"formatToValue (relative)";
+ FormattedRelativeDateTime fv = fmt.formatToValue(-100, UDAT_REL_UNIT_YEAR, status);
+ const char16_t* expectedString = u"one hundred years ago";
+ static const UFieldPositionWithCategory expectedFieldPositions[] = {
+ {UFIELD_CATEGORY_RELATIVE_DATETIME, UDAT_REL_NUMERIC_FIELD, 0, 11},
+ {UFIELD_CATEGORY_RELATIVE_DATETIME, UDAT_REL_LITERAL_FIELD, 12, 21}};
+ checkMixedFormattedValue(
+ message,
+ fv,
+ expectedString,
+ expectedFieldPositions,
+ UPRV_LENGTHOF(expectedFieldPositions));
+ }
+}
+
static const char *kLast2 = "Last_2";
static const char *kLast = "Last";
static const char *kThis = "This";
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantAffixModifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantAffixModifier.java
index fc881a2c504..c82d50d7e01 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantAffixModifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantAffixModifier.java
@@ -2,7 +2,7 @@
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.impl.number;
-import com.ibm.icu.text.NumberFormat.Field;
+import java.text.Format.Field;
/**
* The canonical implementation of {@link Modifier}, containing a prefix and suffix string.
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantMultiFieldModifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantMultiFieldModifier.java
index d53349204be..673296005a8 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantMultiFieldModifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/ConstantMultiFieldModifier.java
@@ -2,10 +2,9 @@
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.impl.number;
+import java.text.Format.Field;
import java.util.Arrays;
-import com.ibm.icu.text.NumberFormat.Field;
-
/**
* An implementation of {@link Modifier} that allows for multiple types of fields in the same modifier.
* Constructed based on the contents of two {@link NumberStringBuilder} instances (one for the prefix,
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/CurrencySpacingEnabledModifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/CurrencySpacingEnabledModifier.java
index 2cf875884e5..61c04c53a4a 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/CurrencySpacingEnabledModifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/CurrencySpacingEnabledModifier.java
@@ -2,6 +2,8 @@
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.impl.number;
+import java.text.Format.Field;
+
import com.ibm.icu.text.DecimalFormatSymbols;
import com.ibm.icu.text.NumberFormat;
import com.ibm.icu.text.UnicodeSet;
@@ -122,7 +124,7 @@ public class CurrencySpacingEnabledModifier extends ConstantMultiFieldModifier {
// NOTE: For prefix, output.fieldAt(index-1) gets the last field type in the prefix.
// This works even if the last code point in the prefix is 2 code units because the
// field value gets populated to both indices in the field array.
- NumberFormat.Field affixField = (affix == PREFIX) ? output.fieldAt(index - 1)
+ Field affixField = (affix == PREFIX) ? output.fieldAt(index - 1)
: output.fieldAt(index);
if (affixField != NumberFormat.Field.CURRENCY) {
return 0;
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/Modifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/Modifier.java
index d0e74bbe093..f3f4635fedb 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/Modifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/Modifier.java
@@ -2,8 +2,9 @@
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.impl.number;
+import java.text.Format.Field;
+
import com.ibm.icu.impl.StandardPlural;
-import com.ibm.icu.text.NumberFormat.Field;
/**
* A Modifier is an object that can be passed through the formatting pipeline until it is finally applied
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/MutablePatternModifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/MutablePatternModifier.java
index d8875610bf8..4cdde30d78c 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/MutablePatternModifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/MutablePatternModifier.java
@@ -326,7 +326,7 @@ public class MutablePatternModifier implements Modifier, SymbolProvider, MicroPr
}
@Override
- public boolean containsField(Field field) {
+ public boolean containsField(java.text.Format.Field field) {
// This method is not currently used. (unsafe path not used in range formatting)
assert false;
return false;
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/NumberStringBuilder.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/NumberStringBuilder.java
index 5102db4b518..0380b0e59b7 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/NumberStringBuilder.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/NumberStringBuilder.java
@@ -5,15 +5,14 @@ package com.ibm.icu.impl.number;
import java.text.AttributedCharacterIterator;
import java.text.AttributedString;
import java.text.FieldPosition;
+import java.text.Format.Field;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import com.ibm.icu.impl.StaticUnicodeSets;
import com.ibm.icu.text.ConstrainedFieldPosition;
-import com.ibm.icu.text.ConstrainedFieldPosition.ConstraintType;
import com.ibm.icu.text.NumberFormat;
-import com.ibm.icu.text.NumberFormat.Field;
import com.ibm.icu.text.UnicodeSet;
/**
@@ -521,7 +520,7 @@ public class NumberStringBuilder implements CharSequence {
ConstrainedFieldPosition cfpos = new ConstrainedFieldPosition();
cfpos.constrainField(rawField);
cfpos.setState(rawField, null, fp.getBeginIndex(), fp.getEndIndex());
- if (nextPosition(cfpos)) {
+ if (nextPosition(cfpos, null)) {
fp.setBeginIndex(cfpos.getStart());
fp.setEndIndex(cfpos.getLimit());
return true;
@@ -545,28 +544,38 @@ public class NumberStringBuilder implements CharSequence {
return false;
}
- public AttributedCharacterIterator toCharacterIterator() {
+ public AttributedCharacterIterator toCharacterIterator(Field numericField) {
ConstrainedFieldPosition cfpos = new ConstrainedFieldPosition();
AttributedString as = new AttributedString(toString());
- while (this.nextPosition(cfpos)) {
+ while (this.nextPosition(cfpos, numericField)) {
// Backwards compatibility: field value = field
as.addAttribute(cfpos.getField(), cfpos.getField(), cfpos.getStart(), cfpos.getLimit());
}
return as.getIterator();
}
- public boolean nextPosition(ConstrainedFieldPosition cfpos) {
- if (cfpos.getConstraintType() == ConstraintType.CLASS
- && !cfpos.getClassConstraint().isAssignableFrom(NumberFormat.Field.class)) {
- return false;
+ static class NullField extends Field {
+ private static final long serialVersionUID = 1L;
+ static final NullField END = new NullField("end");
+ private NullField(String name) {
+ super(name);
}
+ }
- boolean isSearchingForField = (cfpos.getConstraintType() == ConstraintType.FIELD);
-
+ /**
+ * Implementation of nextPosition consistent with the contract of FormattedValue.
+ *
+ * @param cfpos
+ * The argument passed to the public API.
+ * @param numericField
+ * Optional. If non-null, apply this field to the entire numeric portion of the string.
+ * @return See FormattedValue#nextPosition.
+ */
+ public boolean nextPosition(ConstrainedFieldPosition cfpos, Field numericField) {
int fieldStart = -1;
Field currField = null;
for (int i = zero + cfpos.getLimit(); i <= zero + length; i++) {
- Field _field = (i < zero + length) ? fields[i] : null;
+ Field _field = (i < zero + length) ? fields[i] : NullField.END;
// Case 1: currently scanning a field.
if (currField != null) {
if (currField != _field) {
@@ -592,9 +601,10 @@ public class NumberStringBuilder implements CharSequence {
continue;
}
// Special case: coalesce the INTEGER if we are pointing at the end of the INTEGER.
- if ((!isSearchingForField || cfpos.getField() == NumberFormat.Field.INTEGER)
+ if (cfpos.matchesField(NumberFormat.Field.INTEGER)
&& i > zero
- && i - zero > cfpos.getLimit() // don't return the same field twice in a row
+ // don't return the same field twice in a row:
+ && i - zero > cfpos.getLimit()
&& isIntOrGroup(fields[i - 1])
&& !isIntOrGroup(_field)) {
int j = i - 1;
@@ -602,16 +612,29 @@ public class NumberStringBuilder implements CharSequence {
cfpos.setState(NumberFormat.Field.INTEGER, null, j - zero + 1, i - zero);
return true;
}
+ // Special case: coalesce NUMERIC if we are pointing at the end of the NUMERIC.
+ if (numericField != null
+ && cfpos.matchesField(numericField)
+ && i > zero
+ // don't return the same field twice in a row:
+ && (i - zero > cfpos.getLimit() || cfpos.getField() != numericField)
+ && isNumericField(fields[i - 1])
+ && !isNumericField(_field)) {
+ int j = i - 1;
+ for (; j >= zero && isNumericField(fields[j]); j--) {}
+ cfpos.setState(numericField, null, j - zero + 1, i - zero);
+ return true;
+ }
// Special case: skip over INTEGER; will be coalesced later.
if (_field == NumberFormat.Field.INTEGER) {
_field = null;
}
// Case 2: no field starting at this position.
- if (_field == null) {
+ if (_field == null || _field == NullField.END) {
continue;
}
// Case 3: check for field starting at this position
- if (!isSearchingForField || cfpos.getField() == _field) {
+ if (cfpos.matchesField(_field)) {
fieldStart = i - zero;
currField = _field;
}
@@ -621,10 +644,14 @@ public class NumberStringBuilder implements CharSequence {
return false;
}
- private static boolean isIntOrGroup(NumberFormat.Field field) {
+ private static boolean isIntOrGroup(Field field) {
return field == NumberFormat.Field.INTEGER || field == NumberFormat.Field.GROUPING_SEPARATOR;
}
+ private static boolean isNumericField(Field field) {
+ return field == null || NumberFormat.Field.class.isAssignableFrom(field.getClass());
+ }
+
private int trimBack(int limit) {
return StaticUnicodeSets.get(StaticUnicodeSets.Key.DEFAULT_IGNORABLES)
.spanBack(this, limit, UnicodeSet.SpanCondition.CONTAINED);
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/SimpleModifier.java b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/SimpleModifier.java
index 30c12d61a82..26cb275c5f7 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/impl/number/SimpleModifier.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/impl/number/SimpleModifier.java
@@ -2,9 +2,10 @@
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.impl.number;
+import java.text.Format.Field;
+
import com.ibm.icu.impl.SimpleFormatterImpl;
import com.ibm.icu.impl.number.range.PrefixInfixSuffixLengthHelper;
-import com.ibm.icu.text.NumberFormat.Field;
import com.ibm.icu.util.ICUException;
/**
@@ -65,7 +66,7 @@ public class SimpleModifier implements Modifier {
@Override
public int apply(NumberStringBuilder output, int leftIndex, int rightIndex) {
- return formatAsPrefixSuffix(output, leftIndex, rightIndex, field);
+ return formatAsPrefixSuffix(output, leftIndex, rightIndex);
}
@Override
@@ -139,8 +140,7 @@ public class SimpleModifier implements Modifier {
public int formatAsPrefixSuffix(
NumberStringBuilder result,
int startIndex,
- int endIndex,
- Field field) {
+ int endIndex) {
if (suffixOffset == -1) {
// There is no argument for the inner number; overwrite the entire segment with our string.
return result.splice(startIndex, endIndex, compiledPattern, 2, 2 + prefixLength, field);
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumber.java b/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumber.java
index 24a78ae04a9..09da4247e37 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumber.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumber.java
@@ -101,7 +101,7 @@ public class FormattedNumber implements FormattedValue {
*/
@Override
public boolean nextPosition(ConstrainedFieldPosition cfpos) {
- return nsb.nextPosition(cfpos);
+ return nsb.nextPosition(cfpos, null);
}
/**
@@ -150,7 +150,7 @@ public class FormattedNumber implements FormattedValue {
*/
@Override
public AttributedCharacterIterator toCharacterIterator() {
- return nsb.toCharacterIterator();
+ return nsb.toCharacterIterator(null);
}
/**
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumberRange.java b/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumberRange.java
index 56f2481fae6..3b37559fe6a 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumberRange.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumberRange.java
@@ -107,7 +107,7 @@ public class FormattedNumberRange implements FormattedValue {
*/
@Override
public boolean nextPosition(ConstrainedFieldPosition cfpos) {
- return string.nextPosition(cfpos);
+ return string.nextPosition(cfpos, null);
}
/**
@@ -151,7 +151,7 @@ public class FormattedNumberRange implements FormattedValue {
*/
@Override
public AttributedCharacterIterator toCharacterIterator() {
- return string.toCharacterIterator();
+ return string.toCharacterIterator(null);
}
/**
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/number/LocalizedNumberFormatter.java b/icu4j/main/classes/core/src/com/ibm/icu/number/LocalizedNumberFormatter.java
index 6452130d277..281aca5983e 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/number/LocalizedNumberFormatter.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/number/LocalizedNumberFormatter.java
@@ -133,6 +133,13 @@ public class LocalizedNumberFormatter extends NumberFormatterSettings
* QuanitityFormatter appears here instead of in com.ibm.icu.impl because it depends on
* PluralRules and DecimalFormat. It is package-protected as it is not meant for public use.
@@ -101,24 +100,6 @@ class QuantityFormatter {
return StandardPlural.orOtherFromString(pluralKeyword);
}
- /**
- * Selects the standard plural form for the number/formatter/rules.
- */
- public static StandardPlural selectPlural(
- Number number, NumberFormat fmt, PluralRules rules,
- StringBuffer formattedNumber, FieldPosition pos) {
- UFieldPosition fpos = new UFieldPosition(pos.getFieldAttribute(), pos.getField());
- fmt.format(number, formattedNumber, fpos);
- // TODO: Long, BigDecimal & BigInteger may not fit into doubleValue().
- FixedDecimal fd = new FixedDecimal(
- number.doubleValue(),
- fpos.getCountVisibleFractionDigits(), fpos.getFractionDigits());
- String pluralKeyword = rules.select(fd);
- pos.setBeginIndex(fpos.getBeginIndex());
- pos.setEndIndex(fpos.getEndIndex());
- return StandardPlural.orOtherFromString(pluralKeyword);
- }
-
/**
* Formats the pattern with the value and adjusts the FieldPosition.
*/
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/text/RelativeDateTimeFormatter.java b/icu4j/main/classes/core/src/com/ibm/icu/text/RelativeDateTimeFormatter.java
index 3cba6ac371a..f451fdfa455 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/text/RelativeDateTimeFormatter.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/text/RelativeDateTimeFormatter.java
@@ -8,20 +8,28 @@
*/
package com.ibm.icu.text;
+import java.io.IOException;
+import java.io.InvalidObjectException;
+import java.text.AttributedCharacterIterator;
+import java.text.Format;
import java.util.EnumMap;
import java.util.Locale;
import com.ibm.icu.impl.CacheBase;
-import com.ibm.icu.impl.DontCareFieldPosition;
import com.ibm.icu.impl.ICUData;
import com.ibm.icu.impl.ICUResourceBundle;
import com.ibm.icu.impl.SimpleFormatterImpl;
import com.ibm.icu.impl.SoftCache;
import com.ibm.icu.impl.StandardPlural;
import com.ibm.icu.impl.UResource;
+import com.ibm.icu.impl.number.DecimalQuantity;
+import com.ibm.icu.impl.number.DecimalQuantity_DualStorageBCD;
+import com.ibm.icu.impl.number.NumberStringBuilder;
+import com.ibm.icu.impl.number.SimpleModifier;
import com.ibm.icu.lang.UCharacter;
import com.ibm.icu.util.Calendar;
import com.ibm.icu.util.ICUException;
+import com.ibm.icu.util.ICUUncheckedIOException;
import com.ibm.icu.util.ULocale;
import com.ibm.icu.util.UResourceBundle;
@@ -386,6 +394,156 @@ public final class RelativeDateTimeFormatter {
SATURDAY,
}
+ /**
+ * Field constants used when accessing field information for relative
+ * datetime strings in FormattedValue.
+ *
+ * There is no public constructor to this class; the only instances are the
+ * constants defined here.
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public static class Field extends Format.Field {
+ private static final long serialVersionUID = -5327685528663492325L;
+
+ /**
+ * Represents a literal text string, like "tomorrow" or "days ago".
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public static final Field LITERAL = new Field("literal");
+
+ /**
+ * Represents a number quantity, like "3" in "3 days ago".
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public static final Field NUMERIC = new Field("numeric");
+
+ private Field(String fieldName) {
+ super(fieldName);
+ }
+
+ /**
+ * Serizalization method resolve instances to the constant Field values
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ protected Object readResolve() throws InvalidObjectException {
+ if (this.getName().equals(LITERAL.getName()))
+ return LITERAL;
+ if (this.getName().equals(NUMERIC.getName()))
+ return NUMERIC;
+
+ throw new InvalidObjectException("An invalid object.");
+ }
+ }
+
+ /**
+ * Represents the result of a formatting operation of a relative datetime.
+ * Access the string value or field information.
+ *
+ * @author sffc
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public static class FormattedRelativeDateTime implements FormattedValue {
+
+ private final NumberStringBuilder string;
+
+ private FormattedRelativeDateTime(NumberStringBuilder string) {
+ this.string = string;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public String toString() {
+ return string.toString();
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public int length() {
+ return string.length();
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public char charAt(int index) {
+ return string.charAt(index);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public CharSequence subSequence(int start, int end) {
+ return string.subString(start, end);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public A appendTo(A appendable) {
+ try {
+ appendable.append(string);
+ } catch (IOException e) {
+ // Throw as an unchecked exception to avoid users needing try/catch
+ throw new ICUUncheckedIOException(e);
+ }
+ return appendable;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public boolean nextPosition(ConstrainedFieldPosition cfpos) {
+ return string.nextPosition(cfpos, Field.NUMERIC);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ @Override
+ public AttributedCharacterIterator toCharacterIterator() {
+ return string.toCharacterIterator(Field.NUMERIC);
+ }
+ }
+
/**
* Returns a RelativeDateTimeFormatter for the default locale.
* @stable ICU 53
@@ -482,7 +640,11 @@ public final class RelativeDateTimeFormatter {
/**
* Formats a relative date with a quantity such as "in 5 days" or
- * "3 months ago"
+ * "3 months ago".
+ *
+ * This method returns a String. To get more information about the
+ * formatting result, use formatToValue().
+ *
* @param quantity The numerical amount e.g 5. This value is formatted
* according to this object's {@link NumberFormat} object.
* @param direction NEXT means a future relative date; LAST means a past
@@ -494,25 +656,57 @@ public final class RelativeDateTimeFormatter {
* @stable ICU 53
*/
public String format(double quantity, Direction direction, RelativeUnit unit) {
+ NumberStringBuilder output = formatImpl(quantity, direction, unit);
+ return adjustForContext(output.toString());
+ }
+
+ /**
+ * Formats a relative date with a quantity such as "in 5 days" or
+ * "3 months ago".
+ *
+ * This method returns a FormattedRelativeDateTime, which exposes more
+ * information than the String returned by format().
+ *
+ * @param quantity The numerical amount e.g 5. This value is formatted
+ * according to this object's {@link NumberFormat} object.
+ * @param direction NEXT means a future relative date; LAST means a past
+ * relative date.
+ * @param unit the unit e.g day? month? year?
+ * @return the formatted relative datetime
+ * @throws IllegalArgumentException if direction is something other than
+ * NEXT or LAST.
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public FormattedRelativeDateTime formatToValue(double quantity, Direction direction, RelativeUnit unit) {
+ checkNoAdjustForContext();
+ return new FormattedRelativeDateTime(formatImpl(quantity, direction, unit));
+ }
+
+ /** Implementation method for format and formatToValue with RelativeUnit */
+ private NumberStringBuilder formatImpl(double quantity, Direction direction, RelativeUnit unit) {
if (direction != Direction.LAST && direction != Direction.NEXT) {
throw new IllegalArgumentException("direction must be NEXT or LAST");
}
- String result;
int pastFutureIndex = (direction == Direction.NEXT ? 1 : 0);
- // This class is thread-safe, yet numberFormat is not. To ensure thread-safety of this
- // class we must guarantee that only one thread at a time uses our numberFormat.
- synchronized (numberFormat) {
- StringBuffer formatStr = new StringBuffer();
- DontCareFieldPosition fieldPosition = DontCareFieldPosition.INSTANCE;
- StandardPlural pluralForm = QuantityFormatter.selectPlural(quantity,
- numberFormat, pluralRules, formatStr, fieldPosition);
-
- String formatter = getRelativeUnitPluralPattern(style, unit, pastFutureIndex, pluralForm);
- result = SimpleFormatterImpl.formatCompiledPattern(formatter, formatStr);
+ NumberStringBuilder output = new NumberStringBuilder();
+ String pluralKeyword;
+ if (numberFormat instanceof DecimalFormat) {
+ DecimalQuantity dq = new DecimalQuantity_DualStorageBCD(quantity);
+ ((DecimalFormat) numberFormat).toNumberFormatter().formatImpl(dq, output);
+ pluralKeyword = pluralRules.select(dq);
+ } else {
+ String result = numberFormat.format(quantity);
+ output.append(result, null);
+ pluralKeyword = pluralRules.select(quantity);
}
- return adjustForContext(result);
+ StandardPlural pluralForm = StandardPlural.orOtherFromString(pluralKeyword);
+ String compiledPattern = getRelativeUnitPluralPattern(style, unit, pastFutureIndex, pluralForm);
+ SimpleModifier modifier = new SimpleModifier(compiledPattern, Field.LITERAL, false);
+ modifier.formatAsPrefixSuffix(output, 0, output.length());
+ return output;
}
/**
@@ -520,6 +714,9 @@ public final class RelativeDateTimeFormatter {
* using a numeric style, e.g. "1 week ago", "in 1 week",
* "5 weeks ago", "in 5 weeks".
*
+ * This method returns a String. To get more information about the
+ * formatting result, use formatNumericToValue().
+ *
* @param offset The signed offset for the specified unit. This
* will be formatted according to this object's
* NumberFormat object.
@@ -530,6 +727,35 @@ public final class RelativeDateTimeFormatter {
* @stable ICU 57
*/
public String formatNumeric(double offset, RelativeDateTimeUnit unit) {
+ NumberStringBuilder output = formatNumericImpl(offset, unit);
+ return adjustForContext(output.toString());
+ }
+
+ /**
+ * Format a combination of RelativeDateTimeUnit and numeric offset
+ * using a numeric style, e.g. "1 week ago", "in 1 week",
+ * "5 weeks ago", "in 5 weeks".
+ *
+ * This method returns a FormattedRelativeDateTime, which exposes more
+ * information than the String returned by formatNumeric().
+ *
+ * @param offset The signed offset for the specified unit. This
+ * will be formatted according to this object's
+ * NumberFormat object.
+ * @param unit The unit to use when formatting the relative
+ * date, e.g. RelativeDateTimeUnit.WEEK,
+ * RelativeDateTimeUnit.FRIDAY.
+ * @return The formatted string (may be empty in case of error)
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public FormattedRelativeDateTime formatNumericToValue(double offset, RelativeDateTimeUnit unit) {
+ checkNoAdjustForContext();
+ return new FormattedRelativeDateTime(formatNumericImpl(offset, unit));
+ }
+
+ /** Implementation method for formatNumeric and formatNumericToValue */
+ private NumberStringBuilder formatNumericImpl(double offset, RelativeDateTimeUnit unit) {
// TODO:
// The full implementation of this depends on CLDR data that is not yet available,
// see: http://unicode.org/cldr/trac/ticket/9165 Add more relative field data.
@@ -555,8 +781,7 @@ public final class RelativeDateTimeFormatter {
direction = Direction.LAST;
offset = -offset;
}
- String result = format(offset, direction, relunit);
- return (result != null)? result: "";
+ return formatImpl(offset, direction, relunit);
}
private int[] styleToDateFormatSymbolsWidth = {
@@ -565,6 +790,10 @@ public final class RelativeDateTimeFormatter {
/**
* Formats a relative date without a quantity.
+ *
+ * This method returns a String. To get more information about the
+ * formatting result, use formatToValue().
+ *
* @param direction NEXT, LAST, THIS, etc.
* @param unit e.g SATURDAY, DAY, MONTH
* @return the formatted string. If direction has a value that is documented as not being
@@ -575,6 +804,39 @@ public final class RelativeDateTimeFormatter {
* @stable ICU 53
*/
public String format(Direction direction, AbsoluteUnit unit) {
+ String result = formatAbsoluteImpl(direction, unit);
+ return result != null ? adjustForContext(result) : null;
+ }
+
+ /**
+ * Formats a relative date without a quantity.
+ *
+ * This method returns a FormattedRelativeDateTime, which exposes more
+ * information than the String returned by format().
+ *
+ * @param direction NEXT, LAST, THIS, etc.
+ * @param unit e.g SATURDAY, DAY, MONTH
+ * @return the formatted string. If direction has a value that is documented as not being
+ * fully supported in every locale (for example NEXT_2 or LAST_2) then this function may
+ * return null to signal that no formatted string is available.
+ * @throws IllegalArgumentException if the direction is incompatible with
+ * unit this can occur with NOW which can only take PLAIN.
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public FormattedRelativeDateTime formatToValue(Direction direction, AbsoluteUnit unit) {
+ checkNoAdjustForContext();
+ String string = formatAbsoluteImpl(direction, unit);
+ if (string == null) {
+ return null;
+ }
+ NumberStringBuilder nsb = new NumberStringBuilder();
+ nsb.append(string, Field.LITERAL);
+ return new FormattedRelativeDateTime(nsb);
+ }
+
+ /** Implementation method for format and formatToValue with AbsoluteUnit */
+ private String formatAbsoluteImpl(Direction direction, AbsoluteUnit unit) {
if (unit == AbsoluteUnit.NOW && direction != Direction.PLAIN) {
throw new IllegalArgumentException("NOW can only accept direction PLAIN.");
}
@@ -592,7 +854,7 @@ public final class RelativeDateTimeFormatter {
// Not PLAIN, or not a weekday.
result = getAbsoluteUnitString(style, unit, direction);
}
- return result != null ? adjustForContext(result) : null;
+ return result;
}
/**
@@ -602,6 +864,9 @@ public final class RelativeDateTimeFormatter {
* style if no appropriate text term is available for the specified
* offset in the object’s locale.
*
+ * This method returns a String. To get more information about the
+ * formatting result, use formatToValue().
+ *
* @param offset The signed offset for the specified field.
* @param unit The unit to use when formatting the relative
* date, e.g. RelativeDateTimeUnit.WEEK,
@@ -610,6 +875,43 @@ public final class RelativeDateTimeFormatter {
* @stable ICU 57
*/
public String format(double offset, RelativeDateTimeUnit unit) {
+ return adjustForContext(formatRelativeImpl(offset, unit).toString());
+ }
+
+ /**
+ * Format a combination of RelativeDateTimeUnit and numeric offset
+ * using a text style if possible, e.g. "last week", "this week",
+ * "next week", "yesterday", "tomorrow". Falls back to numeric
+ * style if no appropriate text term is available for the specified
+ * offset in the object’s locale.
+ *
+ * This method returns a FormattedRelativeDateTime, which exposes more
+ * information than the String returned by format().
+ *
+ * @param offset The signed offset for the specified field.
+ * @param unit The unit to use when formatting the relative
+ * date, e.g. RelativeDateTimeUnit.WEEK,
+ * RelativeDateTimeUnit.FRIDAY.
+ * @return The formatted string (may be empty in case of error)
+ * @draft ICU 64
+ * @provisional This API might change or be removed in a future release.
+ */
+ public FormattedRelativeDateTime formatToValue(double offset, RelativeDateTimeUnit unit) {
+ checkNoAdjustForContext();
+ CharSequence cs = formatRelativeImpl(offset, unit);
+ NumberStringBuilder nsb;
+ if (cs instanceof NumberStringBuilder) {
+ nsb = (NumberStringBuilder) cs;
+ } else {
+ nsb = new NumberStringBuilder();
+ nsb.append(cs, Field.LITERAL);
+ }
+ return new FormattedRelativeDateTime(nsb);
+ }
+
+
+ /** Implementation method for format and formatToValue with RelativeDateTimeUnit. */
+ private CharSequence formatRelativeImpl(double offset, RelativeDateTimeUnit unit) {
// TODO:
// The full implementation of this depends on CLDR data that is not yet available,
// see: http://unicode.org/cldr/trac/ticket/9165 Add more relative field data.
@@ -661,13 +963,13 @@ public final class RelativeDateTimeFormatter {
break;
}
if (!useNumeric) {
- String result = format(direction, absunit);
+ String result = formatAbsoluteImpl(direction, absunit);
if (result != null && result.length() > 0) {
return result;
}
}
// otherwise fallback to formatNumeric
- return formatNumeric(offset, unit);
+ return formatNumericImpl(offset, unit);
}
/**
@@ -756,6 +1058,12 @@ public final class RelativeDateTimeFormatter {
}
}
+ private void checkNoAdjustForContext() {
+ if (breakIterator != null) {
+ throw new UnsupportedOperationException("Capitalization context is not supported in formatV");
+ }
+ }
+
private RelativeDateTimeFormatter(
EnumMap>> qualitativeUnitMap,
EnumMap> patternMap,
diff --git a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/FormattedValueTest.java b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/FormattedValueTest.java
index fc50106503d..0811a7a1334 100644
--- a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/FormattedValueTest.java
+++ b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/FormattedValueTest.java
@@ -128,7 +128,7 @@ public class FormattedValueTest {
String baseMessage = message + ": " + fv.toString() + ": ";
// Check the String and CharSequence
- assertEquals(baseMessage + "string", expectedString, fv.toString());
+ assertEquals(baseMessage + " string", expectedString, fv.toString());
assertCharSequenceEquals(expectedString, fv);
// Check the AttributedCharacterIterator
@@ -159,7 +159,8 @@ public class FormattedValueTest {
assertEquals(baseMessage + expectedField + " end @" + i, expectedEndIndex, actualEndIndex);
attributesRemaining--;
}
- assertEquals(baseMessage + "Should have looked at every field", 0, attributesRemaining);
+ assertEquals(baseMessage + "Should have looked at every field: " + i + ": " + currentAttributes,
+ 0, attributesRemaining);
}
assertEquals(baseMessage + "Should have looked at every character", stringLength, i);
diff --git a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/RelativeDateTimeFormatterTest.java b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/RelativeDateTimeFormatterTest.java
index a7c14d418ea..bada1be0049 100644
--- a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/RelativeDateTimeFormatterTest.java
+++ b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/RelativeDateTimeFormatterTest.java
@@ -21,9 +21,11 @@ import com.ibm.icu.text.NumberFormat;
import com.ibm.icu.text.RelativeDateTimeFormatter;
import com.ibm.icu.text.RelativeDateTimeFormatter.AbsoluteUnit;
import com.ibm.icu.text.RelativeDateTimeFormatter.Direction;
+import com.ibm.icu.text.RelativeDateTimeFormatter.FormattedRelativeDateTime;
import com.ibm.icu.text.RelativeDateTimeFormatter.RelativeDateTimeUnit;
import com.ibm.icu.text.RelativeDateTimeFormatter.RelativeUnit;
import com.ibm.icu.text.RelativeDateTimeFormatter.Style;
+import com.ibm.icu.text.RuleBasedNumberFormat;
import com.ibm.icu.util.ULocale;
@RunWith(JUnit4.class)
@@ -1025,12 +1027,101 @@ public class RelativeDateTimeFormatterTest extends TestFmwk {
assertEquals("narrow: in 6 qtr", "in 6 qtr", w);
}
-@Test
-public void TestLocales() {
- ULocale[] availableLocales = ULocale.getAvailableLocales();
- for (ULocale loc: availableLocales) {
- RelativeDateTimeFormatter.getInstance(loc);
+ @Test
+ public void TestLocales() {
+ ULocale[] availableLocales = ULocale.getAvailableLocales();
+ for (ULocale loc: availableLocales) {
+ RelativeDateTimeFormatter.getInstance(loc);
+ }
+ }
+
+ @Test
+ public void TestFields() {
+ RelativeDateTimeFormatter fmt = RelativeDateTimeFormatter.getInstance(ULocale.US);
+
+ {
+ String message = "automatic absolute unit";
+ FormattedRelativeDateTime fv = fmt.formatToValue(1, RelativeDateTimeUnit.DAY);
+ String expectedString = "tomorrow";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.LITERAL, 0, 8}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+ {
+ String message = "automatic numeric unit";
+ FormattedRelativeDateTime fv = fmt.formatToValue(3, RelativeDateTimeUnit.DAY);
+ String expectedString = "in 3 days";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.LITERAL, 0, 2},
+ {NumberFormat.Field.INTEGER, 3, 4},
+ {RelativeDateTimeFormatter.Field.NUMERIC, 3, 4},
+ {RelativeDateTimeFormatter.Field.LITERAL, 5, 9}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+ {
+ String message = "manual absolute unit";
+ FormattedRelativeDateTime fv = fmt.formatToValue(Direction.NEXT, AbsoluteUnit.MONDAY);
+ String expectedString = "next Monday";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.LITERAL, 0, 11}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+ {
+ String message = "manual numeric unit";
+ FormattedRelativeDateTime fv = fmt.formatNumericToValue(1.5, RelativeDateTimeUnit.WEEK);
+ String expectedString = "in 1.5 weeks";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.LITERAL, 0, 2},
+ {NumberFormat.Field.INTEGER, 3, 4},
+ {NumberFormat.Field.DECIMAL_SEPARATOR, 4, 5},
+ {NumberFormat.Field.FRACTION, 5, 6},
+ {RelativeDateTimeFormatter.Field.NUMERIC, 3, 6},
+ {RelativeDateTimeFormatter.Field.LITERAL, 7, 12}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+ {
+ String message = "manual numeric resolved unit";
+ FormattedRelativeDateTime fv = fmt.formatToValue(12, Direction.LAST, RelativeUnit.HOURS);
+ String expectedString = "12 hours ago";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {NumberFormat.Field.INTEGER, 0, 2},
+ {RelativeDateTimeFormatter.Field.NUMERIC, 0, 2},
+ {RelativeDateTimeFormatter.Field.LITERAL, 3, 12}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+
+ // Test when the number field is at the end
+ fmt = RelativeDateTimeFormatter.getInstance(new ULocale("sw"));
+ {
+ String message = "numeric field at end";
+ FormattedRelativeDateTime fv = fmt.formatToValue(12, RelativeDateTimeUnit.HOUR);
+ String expectedString = "baada ya saa 12";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.LITERAL, 0, 12},
+ {NumberFormat.Field.INTEGER, 13, 15},
+ {RelativeDateTimeFormatter.Field.NUMERIC, 13, 15}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
+ }
+
+ @Test
+ public void TestRBNF() {
+ RuleBasedNumberFormat rbnf = new RuleBasedNumberFormat(ULocale.US, RuleBasedNumberFormat.SPELLOUT);
+ RelativeDateTimeFormatter fmt = RelativeDateTimeFormatter.getInstance(ULocale.US, rbnf);
+ assertEquals("format (direction)", "in five seconds", fmt.format(5, Direction.NEXT, RelativeUnit.SECONDS));
+ assertEquals("formatNumeric", "one week ago", fmt.formatNumeric(-1, RelativeDateTimeUnit.WEEK));
+ assertEquals("format (absolute)", "yesterday", fmt.format(Direction.LAST, AbsoluteUnit.DAY));
+ assertEquals("format (relative)", "in forty-two months", fmt.format(42, RelativeDateTimeUnit.MONTH));
+
+ {
+ String message = "formatToValue (relative)";
+ FormattedRelativeDateTime fv = fmt.formatToValue(-100, RelativeDateTimeUnit.YEAR);
+ String expectedString = "one hundred years ago";
+ Object[][] expectedFieldPositions = new Object[][]{
+ {RelativeDateTimeFormatter.Field.NUMERIC, 0, 11},
+ {RelativeDateTimeFormatter.Field.LITERAL, 12, 21}};
+ FormattedValueTest.checkFormattedValue(message, fv, expectedString, expectedFieldPositions);
+ }
}
-}
}
diff --git a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/number/DecimalQuantityTest.java b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/number/DecimalQuantityTest.java
index 3b7199ee9a6..9271d94b49a 100644
--- a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/number/DecimalQuantityTest.java
+++ b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/number/DecimalQuantityTest.java
@@ -22,6 +22,7 @@ import com.ibm.icu.dev.test.TestFmwk;
import com.ibm.icu.impl.number.DecimalFormatProperties;
import com.ibm.icu.impl.number.DecimalQuantity;
import com.ibm.icu.impl.number.DecimalQuantity_DualStorageBCD;
+import com.ibm.icu.impl.number.NumberStringBuilder;
import com.ibm.icu.impl.number.RoundingUtils;
import com.ibm.icu.number.LocalizedNumberFormatter;
import com.ibm.icu.number.NumberFormatter;
@@ -235,8 +236,12 @@ public class DecimalQuantityTest extends TestFmwk {
for (LocalizedNumberFormatter format : formats) {
DecimalQuantity q0 = rq0.createCopy();
DecimalQuantity q1 = rq1.createCopy();
- String s1 = format.format(q0).toString();
- String s2 = format.format(q1).toString();
+ NumberStringBuilder nsb1 = new NumberStringBuilder();
+ NumberStringBuilder nsb2 = new NumberStringBuilder();
+ format.formatImpl(q0, nsb1);
+ format.formatImpl(q1, nsb2);
+ String s1 = nsb1.toString();
+ String s2 = nsb2.toString();
assertEquals("Different output from formatter (" + q0 + ", " + q1 + ")", s1, s2);
}
}
diff --git a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/FormatHandler.java b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/FormatHandler.java
index 7bb5e98fc8a..d34b64453fe 100644
--- a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/FormatHandler.java
+++ b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/FormatHandler.java
@@ -34,6 +34,7 @@ import com.ibm.icu.text.MessageFormat;
import com.ibm.icu.text.NumberFormat;
import com.ibm.icu.text.PluralFormat;
import com.ibm.icu.text.PluralRules;
+import com.ibm.icu.text.RelativeDateTimeFormatter;
import com.ibm.icu.text.RuleBasedNumberFormat;
import com.ibm.icu.text.SelectFormat;
import com.ibm.icu.text.SimpleDateFormat;
@@ -1800,6 +1801,21 @@ public class FormatHandler
}
}
+ public static class RelativeDateTimeFormatterFieldHandler implements SerializableTestUtility.Handler
+ {
+ @Override
+ public Object[] getTestObjects()
+ {
+ return new Object[] {RelativeDateTimeFormatter.Field.LITERAL};
+ }
+
+ @Override
+ public boolean hasSameBehavior(Object a, Object b)
+ {
+ return (a == b);
+ }
+ }
+
public static class DateFormatHandler implements SerializableTestUtility.Handler
{
static HashMap cannedPatterns = new HashMap();
diff --git a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/SerializableTestUtility.java b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/SerializableTestUtility.java
index c1e97c771b3..fe9a601709c 100644
--- a/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/SerializableTestUtility.java
+++ b/icu4j/main/tests/core/src/com/ibm/icu/dev/test/serializable/SerializableTestUtility.java
@@ -818,6 +818,7 @@ public class SerializableTestUtility {
map.put("com.ibm.icu.text.DateFormat$Field", new FormatHandler.DateFormatFieldHandler());
map.put("com.ibm.icu.text.ChineseDateFormat$Field", new FormatHandler.ChineseDateFormatFieldHandler());
map.put("com.ibm.icu.text.MessageFormat$Field", new FormatHandler.MessageFormatFieldHandler());
+ map.put("com.ibm.icu.text.RelativeDateTimeFormatter$Field", new FormatHandler.RelativeDateTimeFormatterFieldHandler());
map.put("com.ibm.icu.impl.duration.BasicDurationFormat", new FormatHandler.BasicDurationFormatHandler());
map.put("com.ibm.icu.impl.RelativeDateFormat", new FormatHandler.RelativeDateFormatHandler());