Update ICU to 58.1

source/i18n/unicode/coll.h

Index: source/i18n/unicode/coll.h
diff --git a/source/i18n/unicode/coll.h b/source/i18n/unicode/coll.h
index add6b5ba368f7b9d99ddd4a03f3619760c215831..e41be2ee81a25c413ea68e4b6ee1b8121d4430c1 100644
--- a/source/i18n/unicode/coll.h
+++ b/source/i18n/unicode/coll.h
@@ -1,15 +1,17 @@
+// Copyright (C) 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
 ******************************************************************************
-*   Copyright (C) 1996-2015, International Business Machines
+*   Copyright (C) 1996-2016, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 ******************************************************************************
 */
 
 /**
- * \file 
+ * \file
  * \brief C++ API: Collation Service.
  */
- 
+
 /**
 * File coll.h
 *
@@ -199,6 +201,9 @@ public:
         IDENTICAL  = UCOL_IDENTICAL  // 15
     };
 
+
+    // Cannot use #ifndef U_HIDE_DEPRECATED_API for the following, it is
+    // used by virtual methods that cannot have that conditional.
     /**
      * LESS is returned if source string is compared to be less than target
      * string in the compare() method.
@@ -479,7 +484,7 @@ public:
      * generated sort keys.
      * If the source string is null, a null collation key will be returned.
      *
-     * Note that sort keys are often less efficient than simply doing comparison.  
+     * Note that sort keys are often less efficient than simply doing comparison.
      * For more details, see the ICU User Guide.
      *
      * @param source the source string to be transformed into a sort key.
@@ -501,7 +506,7 @@ public:
      * generated sort keys.
      * <p>If the source string is null, a null collation key will be returned.
      *
-     * Note that sort keys are often less efficient than simply doing comparison.  
+     * Note that sort keys are often less efficient than simply doing comparison.
      * For more details, see the ICU User Guide.
      *
      * @param source the source string to be transformed into a sort key.
@@ -616,7 +621,7 @@ public:
      * @see Collator#setReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
-     * @stable ICU 4.8 
+     * @stable ICU 4.8
      */
      virtual int32_t getReorderCodes(int32_t *dest,
                                      int32_t destCapacity,
@@ -626,7 +631,7 @@ public:
      * Sets the ordering of scripts for this collator.
      *
      * <p>The reordering codes are a combination of script codes and reorder codes.
-     * @param reorderCodes An array of script codes in the new order. This can be NULL if the 
+     * @param reorderCodes An array of script codes in the new order. This can be NULL if the
      * length is also set to 0. An empty array will clear any reordering codes on the collator.
      * @param reorderCodesLength The length of reorderCodes.
      * @param status error code
@@ -635,7 +640,7 @@ public:
      * @see Collator#getEquivalentReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
-     * @stable ICU 4.8 
+     * @stable ICU 4.8
      */
      virtual void setReorderCodes(const int32_t* reorderCodes,
                                   int32_t reorderCodesLength,
@@ -647,11 +652,11 @@ public:
      * Beginning with ICU 55, scripts only reorder together if they are primary-equal,
      * for example Hiragana and Katakana.
      *
-     * @param reorderCode The reorder code to determine equivalence for. 
+     * @param reorderCode The reorder code to determine equivalence for.
      * @param dest The array to fill with the script equivalence reordering codes.
-     * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the 
+     * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the
      * function will only return the length of the result without writing any codes (pre-flighting).
-     * @param status A reference to an error code value, which must not indicate 
+     * @param status A reference to an error code value, which must not indicate
      * a failure before the function call.
      * @return The length of the of the reordering code equivalence array.
      * @see ucol_setReorderCodes
@@ -659,7 +664,7 @@ public:
      * @see Collator#setReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
-     * @stable ICU 4.8 
+     * @stable ICU 4.8
      */
     static int32_t U_EXPORT2 getEquivalentReorderCodes(int32_t reorderCode,
                                 int32_t* dest,
@@ -981,7 +986,7 @@ public:
      * Sort key byte arrays are zero-terminated and can be compared using
      * strcmp().
      *
-     * Note that sort keys are often less efficient than simply doing comparison.  
+     * Note that sort keys are often less efficient than simply doing comparison.
      * For more details, see the ICU User Guide.
      *
      * @param source string to be processed.
@@ -1001,7 +1006,7 @@ public:
      * Sort key byte arrays are zero-terminated and can be compared using
      * strcmp().
      *
-     * Note that sort keys are often less efficient than simply doing comparison.  
+     * Note that sort keys are often less efficient than simply doing comparison.
      * For more details, see the ICU User Guide.
      *
      * @param source string to be processed.
@@ -1111,18 +1116,18 @@ public:
     virtual void setLocales(const Locale& requestedLocale, const Locale& validLocale, const Locale& actualLocale);
 
     /** Get the short definition string for a collator. This internal API harvests the collator's
-     *  locale and the attribute set and produces a string that can be used for opening 
+     *  locale and the attribute set and produces a string that can be used for opening
      *  a collator with the same attributes using the ucol_openFromShortString API.
      *  This string will be normalized.
      *  The structure and the syntax of the string is defined in the "Naming collators"
-     *  section of the users guide: 
+     *  section of the users guide:
      *  http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme
      *  This function supports preflighting.
-     * 
+     *
      *  This is internal, and intended to be used with delegate converters.
      *
      *  @param locale a locale that will appear as a collators locale in the resulting
-     *                short string definition. If NULL, the locale will be harvested 
+     *                short string definition. If NULL, the locale will be harvested
      *                from the collator.
      *  @param buffer space to hold the resulting string
      *  @param capacity capacity of the buffer