ICU 56 update step 1

source/i18n/unicode/plurrule.h

 /*
 *******************************************************************************
-* Copyright (C) 2008-2014, International Business Machines Corporation and
+* Copyright (C) 2008-2015, International Business Machines Corporation and
 * others. All Rights Reserved.
 *******************************************************************************
 *
 *
 * File PLURRULE.H
 *
 * Modification History:*
 *   Date        Name        Description
 *
 ********************************************************************************
@@ skipping 18 matching lines @@
  * Value returned by PluralRules::getUniqueKeywordValue() when there is no
  * unique value to return.
  * @stable ICU 4.8
  */
 #define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)
 
 U_NAMESPACE_BEGIN
 
 class Hashtable;
 class FixedDecimal;
+class VisibleDigitsWithExponent;
 class RuleChain;
 class PluralRuleParser;
 class PluralKeywordEnumeration;
 class AndConstraint;
 class SharedPluralRules;
 
 /**
  * Defines rules for mapping non-negative numeric values onto a small set of
  * keywords. Rules are constructed from a text description, consisting
  * of a series of keywords and conditions.  The {@link #select} method
@@ skipping 104 matching lines @@
  * The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within'
  * includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's
  * not an error).
  * </p>
 
  * An "identifier" is a sequence of characters that do not have the
  * Unicode Pattern_Syntax or Pattern_White_Space properties.
  * <p>
  * The difference between 'in' and 'within' is that 'in' only includes
  * integers in the specified range, while 'within' includes all values.
- * Using 'within' with a range_list consisting entirely of values is the 
+ * Using 'within' with a range_list consisting entirely of values is the
  * same as using 'in' (it's not an error).
  *</p>
  * <p>
  * Keywords
  * could be defined by users or from ICU locale data. There are 6
  * predefined values in ICU - 'zero', 'one', 'two', 'few', 'many' and
  * 'other'. Callers need to check the value of keyword returned by
  * {@link #select} method.
  * </p>
  *
@@ skipping 117 matching lines @@
     /**
      * Returns whether or not there are overrides.
      * @param locale       the locale to check.
      * @return
      * @internal
      */
     static UBool hasOverride(const Locale &locale);
 
     /**
      * For ICU use only.
-     * creates a  SharedPluralRules object 
+     * creates a  SharedPluralRules object
      * @internal
      */
     static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);
 
     /**
      * For ICU use only.
      * Returns handle to the shared, cached PluralRules instance.
      * Caller must call removeRef() on returned value once it is done with
      * the shared instance.
      * @internal
      */
     static const SharedPluralRules* U_EXPORT2 createSharedInstance(
             const Locale& locale, UPluralType type, UErrorCode& status);
 
-    
+
 #endif  /* U_HIDE_INTERNAL_API */
 
     /**
      * Given a number, returns the keyword of the first rule that applies to
      * the number.  This function can be used with isKeyword* functions to
      * determine the keyword for default plural rules.
      *
      * @param number  The number for which the rule has to be determined.
      * @return        The keyword of the selected rule.
      * @stable ICU 4.0
      */
     UnicodeString select(int32_t number) const;
 
     /**
      * Given a number, returns the keyword of the first rule that applies to
      * the number.  This function can be used with isKeyword* functions to
      * determine the keyword for default plural rules.
      *
      * @param number  The number for which the rule has to be determined.
      * @return        The keyword of the selected rule.
      * @stable ICU 4.0
      */
     UnicodeString select(double number) const;
 
 #ifndef U_HIDE_INTERNAL_API
     /**
       * @internal
       */
     UnicodeString select(const FixedDecimal &number) const;
+    /**
+      * @internal
+      */
+    UnicodeString select(const VisibleDigitsWithExponent &number) const;
 #endif  /* U_HIDE_INTERNAL_API */
 
     /**
      * Returns a list of all rule keywords used in this <code>PluralRules</code>
      * object.  The rule 'other' is always present by default.
      *
      * @param status Output param set to success/failure code on exit, which
      *               must not indicate a failure before the function call.
      * @return       StringEnumeration with the keywords.
      *               The caller must delete the object.
      * @stable ICU 4.0
      */
     StringEnumeration* getKeywords(UErrorCode& status) const;
 
+#ifndef U_HIDE_DEPRECATED_API
     /**
-     * Returns a unique value for this keyword if it exists, else the constant
-     * UPLRULES_NO_UNIQUE_VALUE.
+     * Deprecated Function, does not return useful results.
+     *
+     * Originally intended to return a unique value for this keyword if it exists,
+     * else the constant UPLRULES_NO_UNIQUE_VALUE.
      *
      * @param keyword The keyword.
-     * @return        The unique value that generates the keyword, or
-     *                UPLRULES_NO_UNIQUE_VALUE if the keyword is undefined or there is no
-     *                unique value that generates this keyword.
-     * @stable ICU 4.8
+     * @return        Stub deprecated function returns UPLRULES_NO_UNIQUE_VALUE always.
+     * @deprecated ICU 55
      */
     double getUniqueKeywordValue(const UnicodeString& keyword);
 
     /**
-     * Returns all the values for which select() would return the keyword.  If
-     * the keyword is unknown, returns no values, but this is not an error.  If
+     * Deprecated Function, does not produce useful results.
+     *
+     * Orginally intended to return all the values for which select() would return the keyword.
+     * If the keyword is unknown, returns no values, but this is not an error.  If
      * the number of values is unlimited, returns no values and -1 as the
      * count.
      *
      * The number of returned values is typically small.
      *
      * @param keyword      The keyword.
      * @param dest         Array into which to put the returned values.  May
      *                     be NULL if destCapacity is 0.
      * @param destCapacity The capacity of the array, must be at least 0.
-     * @param status       The error code.
+     * @param status       The error code. Deprecated function, always sets U_UNSUPPORTED_ERROR.
      * @return             The count of values available, or -1.  This count
      *                     can be larger than destCapacity, but no more than
      *                     destCapacity values will be written.
-     * @stable ICU 4.8
+     * @deprecated ICU 55
      */
     int32_t getAllKeywordValues(const UnicodeString &keyword,
                                 double *dest, int32_t destCapacity,
                                 UErrorCode& status);
+#endif  /* U_HIDE_DEPRECATED_API */
 
     /**
      * Returns sample values for which select() would return the keyword.  If
      * the keyword is unknown, returns no values, but this is not an error.
      *
      * The number of returned values is typically small.
      *
      * @param keyword      The keyword.
      * @param dest         Array into which to put the returned values.  May
      *                     be NULL if destCapacity is 0.
@@ skipping 86 matching lines @@
 
     friend class PluralRuleParser;
 };
 
 U_NAMESPACE_END
 
 #endif /* #if !UCONFIG_NO_FORMATTING */
 
 #endif // _PLURRULE
 //eof