organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-14 17:24:01 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 1

ICU-12003 User more links to actual Java classes in ICU API doc.

Browse source 
X-SVN-Rev: 38348
This commit is contained in:
Yoshito Umaoka 2016-02-24 22:01:37 +00:00
parent ebc0f5b22a
commit 82801c4b0a
22 changed files with 166 additions and 139 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
icu4j/main/classes/core/src/com/ibm/icu/lang/UCharacter.java
View file

@ -1,6 +1,6 @@
/**
*******************************************************************************
* Copyright (C) 1996-2015, International Business Machines Corporation and
* Copyright (C) 1996-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -2424,8 +2424,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK 1.5 API. Return the Unicode block with the
* given name. {@icunote} Unlike JDK 1.5, this only matches
* Alternative to the {@link java.lang.Character.UnicodeBlock#forName(String)} method.
* Returns the Unicode block with the given name. {@icunote} Unlike
* {@link java.lang.Character.UnicodeBlock#forName(String)}, this only matches
* against the official UCD name and the Java block name
* (ignoring case).
* @param blockName the name of the block to match
@ -5936,7 +5937,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
public static final int MIN_CODE_POINT = Character.MIN_CODE_POINT;
/**
* Cover the JDK 1.5 API, for convenience.
* Equivalent to {@link Character#isValidCodePoint}.
*
* @param cp the code point to check
* @return true if cp is a valid code point
* @stable ICU 3.0
@ -6193,11 +6195,12 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK API, for convenience. Return a byte representing the directionality of
* the character.
* Equivalent to the {@link Character#getDirectionality(char)} method, for
* convenience. Returns a byte representing the directionality of the
* character.
*
* {@icunote} Unlike the JDK, this returns DIRECTIONALITY_LEFT_TO_RIGHT for undefined
* or out-of-bounds characters.
* {@icunote} Unlike {@link Character#getDirectionality(char)}, this returns
* DIRECTIONALITY_LEFT_TO_RIGHT for undefined or out-of-bounds characters.
*
* {@icunote} The return value must be tested using the constants defined in {@link
* UCharacterDirection} and its interface {@link
@ -6214,7 +6217,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK API, for convenience. Count the number of code points in the range of text.
* Equivalent to the {@link Character#codePointCount(CharSequence, int, int)}
* method, for convenience. Counts the number of code points in the range
* of text.
* @param text the characters to check
* @param start the start of the range
* @param limit the limit of the range
@ -6243,7 +6248,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK API, for convenience. Count the number of code points in the range of text.
* Equivalent to the {@link Character#codePointCount(char[], int, int)} method, for
* convenience. Counts the number of code points in the range of text.
* @param text the characters to check
* @param start the start of the range
* @param limit the limit of the range
@ -6272,7 +6278,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK API, for convenience. Adjust the char index by a code point offset.
* Equivalent to the {@link Character#offsetByCodePoints(CharSequence, int, int)}
* method, for convenience. Adjusts the char index by a code point offset.
* @param text the characters to check
* @param index the index to adjust
* @param codePointOffset the number of code points by which to offset the index
@ -6316,7 +6323,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
}
/**
* Cover the JDK API, for convenience. Adjust the char index by a code point offset.
* Equivalent to the
* {@link Character#offsetByCodePoints(char[], int, int, int, int)}
* method, for convenience. Adjusts the char index by a code point offset.
* @param text the characters to check
* @param start the start of the range to check
* @param count the length of the range to check

85
icu4j/main/classes/core/src/com/ibm/icu/lang/UCharacterEnums.java
View file

@ -1,6 +1,6 @@
/**
*******************************************************************************
* Copyright (C) 2004-2013, International Business Machines Corporation and
* Copyright (C) 2004-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -20,7 +20,7 @@ public class UCharacterEnums {
/**
* 'Enum' for the CharacterCategory constants. These constants are
* compatible in name <b>but not in value</b> with those defined in
* <code>java.lang.Character</code>.
* {@link java.lang.Character}.
* @see UCharacterCategory
* @stable ICU 3.0
*/
@ -239,10 +239,9 @@ public class UCharacterEnums {
}
/**
* 'Enum' for the CharacterDirection constants. There are two sets
* of names, those used in ICU, and those used in the JDK. The
* JDK constants are compatible in name <b>but not in value</b>
* with those defined in <code>java.lang.Character</code>.
* 'Enum' for the CharacterDirection constants. Some constants are
* compatible in name <b>but not in value</b> with those defined in
* {@link java.lang.Character}.
* @see UCharacterDirection
* @stable ICU 3.0
*/
@ -254,7 +253,9 @@ public class UCharacterEnums {
public static final int LEFT_TO_RIGHT = 0;
/**
* JDK-compatible synonym for LEFT_TO_RIGHT.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_LEFT_TO_RIGHT}.
* Synonym of {@link #LEFT_TO_RIGHT}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT = (byte)LEFT_TO_RIGHT;
@ -266,7 +267,9 @@ public class UCharacterEnums {
public static final int RIGHT_TO_LEFT = 1;
/**
* JDK-compatible synonym for RIGHT_TO_LEFT.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_RIGHT_TO_LEFT}.
* Synonym of {@link #RIGHT_TO_LEFT}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT = (byte)RIGHT_TO_LEFT;
@ -278,7 +281,9 @@ public class UCharacterEnums {
public static final int EUROPEAN_NUMBER = 2;
/**
* JDK-compatible synonym for EUROPEAN_NUMBER.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_EUROPEAN_NUMBER}.
* Synonym of {@link #EUROPEAN_NUMBER}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER = (byte)EUROPEAN_NUMBER;
@ -290,7 +295,9 @@ public class UCharacterEnums {
public static final int EUROPEAN_NUMBER_SEPARATOR = 3;
/**
* JDK-compatible synonym for EUROPEAN_NUMBER_SEPARATOR.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR}.
* Synonym of {@link #EUROPEAN_NUMBER_SEPARATOR}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR = (byte)EUROPEAN_NUMBER_SEPARATOR;
@ -302,7 +309,9 @@ public class UCharacterEnums {
public static final int EUROPEAN_NUMBER_TERMINATOR = 4;
/**
* JDK-compatible synonym for EUROPEAN_NUMBER_TERMINATOR.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR}.
* Synonym of {@link #EUROPEAN_NUMBER_TERMINATOR}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR = (byte)EUROPEAN_NUMBER_TERMINATOR;
@ -314,7 +323,9 @@ public class UCharacterEnums {
public static final int ARABIC_NUMBER = 5;
/**
* JDK-compatible synonym for ARABIC_NUMBER.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_ARABIC_NUMBER}.
* Synonym of {@link #ARABIC_NUMBER}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_ARABIC_NUMBER = (byte)ARABIC_NUMBER;
@ -326,7 +337,9 @@ public class UCharacterEnums {
public static final int COMMON_NUMBER_SEPARATOR = 6;
/**
* JDK-compatible synonym for COMMON_NUMBER_SEPARATOR.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_COMMON_NUMBER_SEPARATOR}.
* Synonym of {@link #COMMON_NUMBER_SEPARATOR}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_COMMON_NUMBER_SEPARATOR = (byte)COMMON_NUMBER_SEPARATOR;
@ -338,7 +351,9 @@ public class UCharacterEnums {
public static final int BLOCK_SEPARATOR = 7;
/**
* JDK-compatible synonym for BLOCK_SEPARATOR.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_PARAGRAPH_SEPARATOR}.
* Synonym of {@link #BLOCK_SEPARATOR}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_PARAGRAPH_SEPARATOR = (byte)BLOCK_SEPARATOR;
@ -350,7 +365,9 @@ public class UCharacterEnums {
public static final int SEGMENT_SEPARATOR = 8;
/**
* JDK-compatible synonym for SEGMENT_SEPARATOR.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_SEGMENT_SEPARATOR}.
* Synonym of {@link #SEGMENT_SEPARATOR}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_SEGMENT_SEPARATOR = (byte)SEGMENT_SEPARATOR;
@ -362,7 +379,8 @@ public class UCharacterEnums {
public static final int WHITE_SPACE_NEUTRAL = 9;
/**
* JDK-compatible synonym for WHITE_SPACE_NEUTRAL.
* Equivalent to {@link java.lang.Character#DIRECTIONALITY_WHITESPACE}.
* Synonym of {@link #WHITE_SPACE_NEUTRAL}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_WHITESPACE = (byte)WHITE_SPACE_NEUTRAL;
@ -374,7 +392,8 @@ public class UCharacterEnums {
public static final int OTHER_NEUTRAL = 10;
/**
* JDK-compatible synonym for OTHER_NEUTRAL.
* Equivalent to {@link java.lang.Character#DIRECTIONALITY_OTHER_NEUTRALS}.
* Synonym of {@link #OTHER_NEUTRAL}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_OTHER_NEUTRALS = (byte)OTHER_NEUTRAL;
@ -386,7 +405,9 @@ public class UCharacterEnums {
public static final int LEFT_TO_RIGHT_EMBEDDING = 11;
/**
* JDK-compatible synonym for LEFT_TO_RIGHT_EMBEDDING.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING}.
* Synonym of {@link #LEFT_TO_RIGHT_EMBEDDING}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING = (byte)LEFT_TO_RIGHT_EMBEDDING;
@ -398,7 +419,9 @@ public class UCharacterEnums {
public static final int LEFT_TO_RIGHT_OVERRIDE = 12;
/**
* JDK-compatible synonym for LEFT_TO_RIGHT_OVERRIDE.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE}.
* Synonym of {@link #LEFT_TO_RIGHT_OVERRIDE}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE = (byte)LEFT_TO_RIGHT_OVERRIDE;
@ -410,7 +433,9 @@ public class UCharacterEnums {
public static final int RIGHT_TO_LEFT_ARABIC = 13;
/**
* JDK-compatible synonym for RIGHT_TO_LEFT_ARABIC.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC}.
* Synonym of {@link #RIGHT_TO_LEFT_ARABIC}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC = (byte)RIGHT_TO_LEFT_ARABIC;
@ -422,7 +447,9 @@ public class UCharacterEnums {
public static final int RIGHT_TO_LEFT_EMBEDDING = 14;
/**
* JDK-compatible synonym for RIGHT_TO_LEFT_EMBEDDING.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING}.
* Synonym of {@link #RIGHT_TO_LEFT_EMBEDDING}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING = (byte)RIGHT_TO_LEFT_EMBEDDING;
@ -434,7 +461,9 @@ public class UCharacterEnums {
public static final int RIGHT_TO_LEFT_OVERRIDE = 15;
/**
* JDK-compatible synonym for RIGHT_TO_LEFT_OVERRIDE.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE}.
* Synonym of {@link #RIGHT_TO_LEFT_OVERRIDE}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE = (byte)RIGHT_TO_LEFT_OVERRIDE;
@ -446,7 +475,9 @@ public class UCharacterEnums {
public static final int POP_DIRECTIONAL_FORMAT = 16;
/**
* JDK-compatible synonym for POP_DIRECTIONAL_FORMAT.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_POP_DIRECTIONAL_FORMAT}.
* Synonym of {@link #POP_DIRECTIONAL_FORMAT}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_POP_DIRECTIONAL_FORMAT = (byte)POP_DIRECTIONAL_FORMAT;
@ -458,7 +489,9 @@ public class UCharacterEnums {
public static final int DIR_NON_SPACING_MARK = 17;
/**
* JDK-compatible synonym for DIR_NON_SPACING_MARK.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_NONSPACING_MARK}.
* Synonym of {@link #DIR_NON_SPACING_MARK}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_NONSPACING_MARK = (byte)DIR_NON_SPACING_MARK;
@ -470,7 +503,9 @@ public class UCharacterEnums {
public static final int BOUNDARY_NEUTRAL = 18;
/**
* JDK-compatible synonym for BOUNDARY_NEUTRAL.
* Equivalent to {@link
* java.lang.Character#DIRECTIONALITY_BOUNDARY_NEUTRAL}.
* Synonym of {@link #BOUNDARY_NEUTRAL}.
* @stable ICU 3.0
*/
public static final byte DIRECTIONALITY_BOUNDARY_NEUTRAL = (byte)BOUNDARY_NEUTRAL;

4
icu4j/main/classes/core/src/com/ibm/icu/text/CurrencyDisplayNames.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2009-2015, International Business Machines Corporation and *
* Copyright (C) 2009-2016, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -79,7 +79,7 @@ public abstract class CurrencyDisplayNames {
* for the locale, but not data for the requested ISO code, null is returned
* from those APIs instead of a substitute value.
*
* @param locale the JDK locale into which to localize the names
* @param locale the {@link java.util.Locale} into which to localize the names
* @param noSubstitute if true, do not return substitute values.
* @return a CurrencyDisplayNames
* @stable ICU 54

26
icu4j/main/classes/core/src/com/ibm/icu/text/DateFormat.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (C) 1996-2015, International Business Machines
* Copyright (C) 1996-2016, International Business Machines
* Corporation and others. All Rights Reserved.
*/
@ -1882,10 +1882,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object that can be used to format times in
* the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a time format is desired.
*
* @param timeStyle The type of time format desired. This can be
@ -1905,10 +1901,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object that can be used to format times in
* the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a time format is desired.
*
* @param timeStyle The type of time format desired. This can be
@ -1928,10 +1920,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object that can be used to format dates and times in
* the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a date/time format is desired.
*
* @param dateStyle The type of date format desired. This can be
@ -1956,10 +1944,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object that can be used to format dates and times in
* the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a date/time format is desired.
*
* @param dateStyle The type of date format desired. This can be
@ -2038,10 +2022,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object that can be used to format times in
* the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a time format is desired.
*
* @param timeStyle The type of time format desired. This can be
@ -2058,10 +2038,6 @@ public abstract class DateFormat extends UFormat {
/**
* Creates a {@link DateFormat} object for the default locale that can be used to format
* dates and times in the calendar system specified by <code>cal</code>.
* <p>
* <b>Note:</b> When this functionality is moved into the core JDK, this method
* will probably be replaced by a new overload of {@link DateFormat#getInstance}.
* <p>
* @param cal The calendar system for which a date/time format is desired.
*
* @param dateStyle The type of date format desired. This can be

11
icu4j/main/classes/core/src/com/ibm/icu/text/DateFormatSymbols.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 1996-2015, International Business Machines Corporation and
* Copyright (C) 1996-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -1288,12 +1288,13 @@ public class DateFormatSymbols implements Serializable, Cloneable {
* When a localized display name is not available, the corresponding
* array element will be <code>null</code>.
* <p>
* <b>Note</b>: ICU implements time zone display name formatting algorithm
* <b>Note</b>: ICU implements the time zone display name formatting algorithm
* specified by <a href="http://www.unicode.org/reports/tr35/">UTS#35 Unicode
* Locale Data Markup Language(LDML)</a>. The algorithm supports historic
* display name changes and various different type of names not available in
* JDK. For accessing the full set of time zone string data used by ICU implementation,
* you should use {@link TimeZoneNames} APIs instead.
* display name changes and various different types of names not available in
* {@link java.text.DateFormatSymbols#getZoneStrings()}. For accessing the full
* set of time zone string data used by ICU implementation, you should use
* {@link TimeZoneNames} APIs instead.
*
* @return the time zone strings.
* @stable ICU 2.0

4
icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2008-2015, International Business Machines Corporation and *
* Copyright (C) 2008-2016, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -360,7 +360,7 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
/**
* Construct DateIntervalInfo for the given JDK locale,
* Construct DateIntervalInfo for the given {@link java.util.Locale}.
* @param locale the interval patterns are loaded from the appropriate
* calendar data (specified calendar or default calendar)
* in this locale.

2
icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java
View file

@ -90,7 +90,7 @@ public class DateTimePatternGenerator implements Freezable<DateTimePatternGenera
/**
* Construct a flexible generator according to data for a given locale.
* @param locale The JDK locale to pass.
* @param locale The {@link java.text.Locale} to pass.
* @stable ICU 54
*/
public static DateTimePatternGenerator getInstance(Locale locale) {

4
icu4j/main/classes/core/src/com/ibm/icu/text/DecimalFormatSymbols.java
View file

@ -465,8 +465,8 @@ public class DecimalFormatSymbols implements Cloneable, Serializable {
}
/**
* Returns the currency symbol, for JDK 1.4 compatibility only.
* ICU clients should use the Currency API directly.
* Returns the currency symbol, for {@link DecimalFormatSymbols#getCurrency()} API
* compatibility only. ICU clients should use the Currency API directly.
* @return the currency used, or null
* @stable ICU 3.4
*/

10
icu4j/main/classes/core/src/com/ibm/icu/text/LocaleDisplayNames.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2009-2015, International Business Machines Corporation and *
* Copyright (C) 2009-2016, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -61,7 +61,7 @@ public abstract class LocaleDisplayNames {
/**
* Convenience overload of {@link #getInstance(Locale, DisplayContext...)} that specifies
* {@link DisplayContext#STANDARD_NAMES}.
* @param locale the display JDK locale
* @param locale the display {@link java.util.Locale}
* @return a LocaleDisplayNames instance
* @stable ICU 54
*/
@ -123,9 +123,9 @@ public abstract class LocaleDisplayNames {
}
/**
* Returns an instance of LocaleDisplayNames that returns names formatted for the provided JDK
* locale, using the provided DisplayContext settings
* @param locale the display JDK locale
* Returns an instance of LocaleDisplayNames that returns names formatted for the provided
* {@link java.util.Locale}, using the provided DisplayContext settings
* @param locale the display {@link java.util.Locale}
* @param contexts one or more context settings (e.g. for dialect
* handling, capitalization, etc.
* @return a LocaleDisplayNames instance

12
icu4j/main/classes/core/src/com/ibm/icu/text/MeasureFormat.java
View file

@ -223,9 +223,9 @@ public class MeasureFormat extends UFormat {
}
/**
* Create a format from the JDK locale, formatWidth, and format.
* Create a format from the {@link java.util.Locale} and formatWidth.
*
* @param locale the JDK locale.
* @param locale the {@link java.util.Locale}.
* @param formatWidth hints how long formatted strings should be.
* @return The new MeasureFormat object.
* @stable ICU 54
@ -274,9 +274,9 @@ public class MeasureFormat extends UFormat {
}
/**
* Create a format from the JDK locale, formatWidth, and format.
* Create a format from the {@link java.util.Locale}, formatWidth, and format.
*
* @param locale the JDK locale.
* @param locale the {@link java.util.Locale}.
* @param formatWidth hints how long formatted strings should be.
* @param format This is defensively copied.
* @return The new MeasureFormat object.
@ -635,8 +635,8 @@ public class MeasureFormat extends UFormat {
/**
* Return a formatter for CurrencyAmount objects in the given
* JDK locale.
* @param locale desired JDK locale
* {@link java.util.Locale}.
* @param locale desired {@link java.util.Locale}
* @return a formatter object
* @stable ICU 54
*/

8
icu4j/main/classes/core/src/com/ibm/icu/text/MessageFormat.java
View file

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004-2014, International Business Machines
* Copyright (c) 2004-2016, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -2454,12 +2454,12 @@ public class MessageFormat extends UFormat {
* {@icu} Converts an 'apostrophe-friendly' pattern into a standard
* pattern.
* <em>This is obsolete for ICU 4.8 and higher MessageFormat pattern strings.</em>
* It can still be useful together with the JDK MessageFormat.
* It can still be useful together with {@link java.text.MessageFormat}.
*
* <p>See the class description for more about apostrophes and quoting,
* and differences between ICU and the JDK.
* and differences between ICU and {@link java.text.MessageFormat}.
*
* <p>The JDK MessageFormat and ICU 4.6 and earlier MessageFormat
* <p>{@link java.text.MessageFormat} and ICU 4.6 and earlier MessageFormat
* treat all ASCII apostrophes as
* quotes, which is problematic in some languages, e.g.
* French, where apostrophe is commonly used. This utility

4
icu4j/main/classes/core/src/com/ibm/icu/text/MessagePattern.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2010-2014, International Business Machines
* Copyright (C) 2010-2016, International Business Machines
* Corporation and others. All Rights Reserved.
*******************************************************************************
* created on: 2010aug21
@ -130,7 +130,7 @@ public final class MessagePattern implements Cloneable, Freezable<MessagePattern
* a double apostrophe pattern character.
* A single apostrophe always starts quoted literal text.
* <p>
* This is the behavior of ICU 4.6 and earlier, and of the JDK.
* This is the behavior of ICU 4.6 and earlier, and of {@link java.text.MessageFormat}.
* @stable ICU 4.8
*/
DOUBLE_REQUIRED

6
icu4j/main/classes/core/src/com/ibm/icu/text/NumberFormat.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 1996-2015, International Business Machines Corporation and *
* Copyright (C) 1996-2016, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -1782,8 +1782,8 @@ public abstract class NumberFormat extends UFormat {
private static final long serialVersionUID = -2308460125733713944L;
/**
* Empty constructor. Public for compatibility with JDK which lets the
* compiler generate a default public constructor even though this is
* Empty constructor. Public for API compatibility with historic versions of
* {@link java.text.NumberFormat} which had public constructor even though this is
* an abstract class.
* @stable ICU 2.6
*/

7
icu4j/main/classes/core/src/com/ibm/icu/text/PluralFormat.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2007-2015, International Business Machines Corporation and
* Copyright (C) 2007-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -201,7 +201,8 @@ public class PluralFormat extends UFormat {
}
/**
* Creates a new cardinal-number <code>PluralFormat</code> for a given JDK locale.
* Creates a new cardinal-number <code>PluralFormat</code> for a given
* {@link java.util.Locale}.
* @param locale the <code>PluralFormat</code> will be configured with
* rules for this locale. This locale will also be used for standard
* number formatting.
@ -263,7 +264,7 @@ public class PluralFormat extends UFormat {
/**
* Creates a new <code>PluralFormat</code> for the plural type.
* The standard number formatting will be done using the given JDK locale.
* The standard number formatting will be done using the given {@link java.util.Locale}.
* @param locale the default number formatting will be done using this
* locale.
* @param type The plural type (e.g., cardinal or ordinal).

10
icu4j/main/classes/core/src/com/ibm/icu/text/PluralRules.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2007-2015, International Business Machines Corporation and
* Copyright (C) 2007-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -1823,14 +1823,14 @@ public class PluralRules implements Serializable {
/**
* Provides access to the predefined cardinal-number <code>PluralRules</code> for a given
* JDK locale.
* {@link java.util.Locale}.
* Same as forLocale(locale, PluralType.CARDINAL).
*
* <p>ICU defines plural rules for many locales based on CLDR <i>Language Plural Rules</i>.
* For these predefined rules, see CLDR page at
* http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
*
* @param locale The JDK locale for which a <code>PluralRules</code> object is
* @param locale The locale for which a <code>PluralRules</code> object is
* returned.
* @return The predefined <code>PluralRules</code> object for this locale.
* If there's no predefined rules for this locale, the rules
@ -1867,13 +1867,13 @@ public class PluralRules implements Serializable {
/**
* Provides access to the predefined <code>PluralRules</code> for a given
* JDK locale and the plural type.
* {@link java.util.Locale} and the plural type.
*
* <p>ICU defines plural rules for many locales based on CLDR <i>Language Plural Rules</i>.
* For these predefined rules, see CLDR page at
* http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
*
* @param locale The JDK locale for which a <code>PluralRules</code> object is
* @param locale The locale for which a <code>PluralRules</code> object is
* returned.
* @param type The plural type (e.g., cardinal or ordinal).
* @return The predefined <code>PluralRules</code> object for this locale.

10
icu4j/main/classes/core/src/com/ibm/icu/text/RelativeDateTimeFormatter.java
View file

@ -421,9 +421,9 @@ public final class RelativeDateTimeFormatter {
}
/**
* Returns a RelativeDateTimeFormatter for a particular JDK locale.
* Returns a RelativeDateTimeFormatter for a particular {@link java.util.Locale}.
*
* @param locale the JDK locale.
* @param locale the {@link java.util.Locale}.
* @return An instance of RelativeDateTimeFormatter.
* @stable ICU 54
*/
@ -482,10 +482,10 @@ public final class RelativeDateTimeFormatter {
}
/**
* Returns a RelativeDateTimeFormatter for a particular JDK locale that uses a particular
* NumberFormat object.
* Returns a RelativeDateTimeFormatter for a particular {@link java.util.Locale} that uses a
* particular NumberFormat object.
*
* @param locale the JDK locale
* @param locale the {@link java.util.Locale}
* @param nf the number format object. It is defensively copied to ensure thread-safety
* and immutability of this class.
* @return An instance of RelativeDateTimeFormatter.

6
icu4j/main/classes/core/src/com/ibm/icu/text/SpoofChecker.java
View file

@ -1,6 +1,6 @@
/*
***************************************************************************
* Copyright (C) 2008-2015 International Business Machines Corporation
* Copyright (C) 2008-2016 International Business Machines Corporation
* and others. All Rights Reserved.
***************************************************************************
*
@ -1494,8 +1494,8 @@ public class SpoofChecker {
}
/**
* Get a set of JDK locales for the scripts that are acceptable in strings to be checked. If no limitations on scripts
* have been specified, an empty set will be returned.
* Get a set of {@link java.util.Locale} instances for the scripts that are acceptable in strings to be checked. If no
* limitations on scripts have been specified, an empty set will be returned.
*
* @return A set of locales corresponding to the acceptable scripts.
* @stable ICU 54

7
icu4j/main/classes/core/src/com/ibm/icu/text/TimeZoneFormat.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2011-2015, International Business Machines Corporation and *
* Copyright (C) 2011-2016, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -490,12 +490,13 @@ public class TimeZoneFormat extends UFormat implements Freezable<TimeZoneFormat>
}
/**
* Returns a frozen instance of <code>TimeZoneFormat</code> for the given JDK locale.
* Returns a frozen instance of <code>TimeZoneFormat</code> for the given
* {@link java.text.Locale}.
* <p><b>Note</b>: The instance returned by this method is frozen. If you want to
* customize a TimeZoneFormat, you must use {@link #cloneAsThawed()} to get a
* thawed copy first.
*
* @param locale the JDK locale.
* @param locale the {@link Locale}.
* @return a frozen instance of <code>TimeZoneFormat</code> for the given locale.
* @stable ICU 54
*/

7
icu4j/main/classes/core/src/com/ibm/icu/text/TimeZoneNames.java
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2011-2015, International Business Machines Corporation and
* Copyright (C) 2011-2016, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@ -174,10 +174,11 @@ public abstract class TimeZoneNames implements Serializable {
}
/**
* Returns an instance of <code>TimeZoneNames</code> for the specified JDK locale.
* Returns an instance of <code>TimeZoneNames</code> for the specified
* {@link java.util.Locale}.
*
* @param locale
* The JDK locale.
* The {@link java.util.Locale}.
* @return An instance of <code>TimeZoneDisplayNames</code>
* @stable ICU 54
*/

12
icu4j/main/classes/core/src/com/ibm/icu/util/Currency.java
View file

@ -194,10 +194,10 @@ public class Currency extends MeasureUnit {
/**
* Returns an array of Strings which contain the currency
* identifiers that are valid for the given JDK locale on the
* identifiers that are valid for the given {@link java.util.Locale} on the
* given date. If there are no such identifiers, returns null.
* Returned identifiers are in preference order.
* @param loc the JDK locale for which to retrieve currency codes.
* @param loc the {@link java.util.Locale} for which to retrieve currency codes.
* @param d the date for which to retrieve currency codes for the given locale.
* @return The array of ISO currency codes.
* @stable ICU 54
@ -596,7 +596,8 @@ public class Currency extends MeasureUnit {
* If the resource data for the default locale contains no entry for this currency,
* then the ISO 4217 code is returned.
* <p>
* Note: This method was added for JDK compatibility support and equivalent to
* Note: This method is a convenience equivalent for
* {@link java.util.Currency#getDisplayName()} and is equivalent to
* <code>getName(Locale.getDefault(), LONG_NAME, null)</code>.
*
* @return The display name of this currency
@ -613,8 +614,9 @@ public class Currency extends MeasureUnit {
* If the resource data for the given locale contains no entry for this currency,
* then the ISO 4217 code is returned.
* <p>
* Note: This method was added for JDK compatibility support and equivalent to
* <code>getName(locale, LONG_NAME, null)</code>.
* Note: This method is a convenience equivalent for
* {@link java.util.Currency#getDisplayName(java.util.Locale)} and is equivalent
* to <code>getName(locale, LONG_NAME, null)</code>.
*
* @param locale locale in which to display currency
* @return The display name of this currency for the specified locale

20
icu4j/main/classes/core/src/com/ibm/icu/util/TimeZone.java
View file

@ -150,8 +150,8 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
*/
public static final int TIMEZONE_ICU = 0;
/**
* {@icu} A time zone implementation type indicating JDK TimeZone used by
* <code>getTimeZone</code>, <code>setDefaultTimeZoneType</code>
* {@icu} A time zone implementation type indicating the {@link java.util.TimeZone}
* used by <code>getTimeZone</code>, <code>setDefaultTimeZoneType</code>
* and <code>getDefaultTimeZoneType</code>.
* @stable ICU 4.0
*/
@ -654,16 +654,16 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
* <p>The default implementation in this class returns <code>true</code> if {@link #useDaylightTime()}
* or {@link #inDaylightTime(Date) inDaylightTime(new Date())} returns <code>true</code>.
* <p>
* <strong>Note:</strong> This method was added for JDK compatibility support.
* The JDK's <code>useDaylightTime()</code> only checks the last known rule(s), therefore
* it may return false even the zone observes daylight saving time currently. JDK added
* <code>observesDaylightTime()</code> to resolve the issue. In ICU, {@link #useDaylightTime()}
* works differently. The ICU implementation checks if the zone uses daylight saving time
* in the current calendar year. Therefore, it will never return <code>false</code> if
* daylight saving time is currently used.
* <strong>Note:</strong> This method was added for {@link java.util.TimeZone} compatibility
* support. The {@link java.util.TimeZone#useDaylightTime()} method only checks the last known
* rule(s), therefore it may return false even the zone observes daylight saving time currently.
* {@link java.util.TimeZone} added <code>observesDaylightTime()</code> to resolve the issue.
* In ICU, {@link #useDaylightTime()} works differently. The ICU implementation checks if the
* zone uses daylight saving time in the current calendar year. Therefore, it will never return
* <code>false</code> if daylight saving time is currently used.
* <p>
* ICU's TimeZone subclass implementations override this method to support the same behavior
* with JDK's <code>observesDaylightSavingTime()</code>. Unlike {@link #useDaylightTime()},
* with {@link java.util.TimeZone#observesDaylightTime()}. Unlike {@link #useDaylightTime()},
* the implementation does not take past daylight saving time into account, so
* that this method may return <code>false</code> even when {@link #useDaylightTime()} returns
* <code>true</code>.

17
icu4j/main/classes/core/src/com/ibm/icu/util/ULocale.java
View file

@ -423,7 +423,7 @@ public final class ULocale implements Serializable, Comparable<ULocale> {
/**
* Construct a ULocale object from a {@link java.util.Locale}.
* @param loc a JDK locale
* @param loc a {@link java.util.Locale}
*/
private ULocale(Locale loc) {
this.localeID = getName(forLocale(loc).toString());
@ -433,7 +433,7 @@ public final class ULocale implements Serializable, Comparable<ULocale> {
/**
* {@icu} Returns a ULocale object for a {@link java.util.Locale}.
* The ULocale is canonicalized.
* @param loc a JDK locale
* @param loc a {@link java.util.Locale}
* @stable ICU 3.2
*/
public static ULocale forLocale(Locale loc) {
@ -542,7 +542,7 @@ public final class ULocale implements Serializable, Comparable<ULocale> {
/**
* {@icu} Converts this ULocale object to a {@link java.util.Locale}.
* @return a JDK locale that either exactly represents this object
* @return a {@link java.util.Locale} that either exactly represents this object
* or is the closest approximation.
* @stable ICU 2.8
*/
@ -613,15 +613,16 @@ public final class ULocale implements Serializable, Comparable<ULocale> {
* The default ULocale is synchronized to the default Java Locale. This method checks
* the current default Java Locale and returns an equivalent ULocale.
* <p>
* <b>Note:</b> Before Java 7, the JDK Locale was not able to represent a locale's script.
* Therefore, the script field in the default ULocale is always empty unless
* <b>Note:</b> Before Java 7, the {@link java.util.Locale} was not able to represent a
* locale's script. Therefore, the script field in the default ULocale is always empty unless
* a ULocale with non-empty script is explicitly set by {@link #setDefault(ULocale)}
* on Java 6 or older systems.
* <p>
* <b>Note for ICU 49 or later:</b> Some JRE implementations allow users to override the default
* JDK Locale using system properties - <code>user.language</code>, <code>user.country</code>
* and <code>user.variant</code>. In addition to these system properties, some Java 7
* implementations support <code>user.script</code> for overriding the default Locale's script.
* {@link java.util.Locale} using system properties - <code>user.language</code>,
* <code>user.country</code> and <code>user.variant</code>. In addition to these system
* properties, some Java 7 implementations support <code>user.script</code> for overriding the
* default Locale's script.
* ICU 49 and later versions use the <code>user.script</code> system property on Java 6
* or older systems supporting other <code>user.*</code> system properties to initialize
* the default ULocale. The <code>user.script</code> override for default ULocale is not