[icu-design] ICU API proposal: GenderInfo

[Mark D. ☕ <ma...@ma...>]

subject: ICU API proposal: *<topic>*
------------------------------
Dear ICU team & users,

I would like to propose the following API for: *ICU 50*
Please provide feedback by: *next Tuesday, 2011-02-28*
Designated API reviewer: *Markus*
Ticket: http://bugs.icu-project.org/trac/ticket/9125<http://bugs.icu-project.org/trac/ticket/9125>
com.ibm.icu.util Class GenderInfo

Provide information about gender in locales based on data in CLDR.
Currently supplies gender of lists.

------------------------------

*Nested Class Summary*static
class*GenderInfo.Gender<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
*
          Gender: OTHER means either the information is unavailable, or the
person has declined to state MALE or FEMALE.static class*
GenderInfo.ListGenderStyle<../../../../com/ibm/icu/util/GenderInfo.ListGenderStyle.html>
*
          Enum only meant for use in CLDR and in testing. *Constructor
Summary**GenderInfo<../../../../com/ibm/icu/util/GenderInfo.html#GenderInfo(com.ibm.icu.util.GenderInfo.ListGenderStyle)>
*(GenderInfo.ListGenderStyle<../../../../com/ibm/icu/util/GenderInfo.ListGenderStyle.html>
 genderStyle)
          Only for testing and use with CLDR. *Method Summary*static
GenderInfo <../../../../com/ibm/icu/util/GenderInfo.html>*getInstance<../../../../com/ibm/icu/util/GenderInfo.html#getInstance(java.util.Locale)>
*(java.util.Locale locale)
          Create GenderInfo from a Locale.static
GenderInfo<../../../../com/ibm/icu/util/GenderInfo.html>
*getInstance<../../../../com/ibm/icu/util/GenderInfo.html#getInstance(com.ibm.icu.util.ULocale)>
*(com.ibm.icu.util.ULocale uLocale)
          Create GenderInfo from a ULocale.
GenderInfo.Gender<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
*getListGender<../../../../com/ibm/icu/util/GenderInfo.html#getListGender(com.ibm.icu.util.GenderInfo.Gender...)>
*(GenderInfo.Gender <../../../../com/ibm/icu/util/GenderInfo.Gender.html>
... genders)
          Get the gender of a list, based on locale usage.
GenderInfo.Gender<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
*getListGender<../../../../com/ibm/icu/util/GenderInfo.html#getListGender(java.util.List)>
*(java.util.List<GenderInfo.Gender<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
> genders)
          Get the gender of a list, based on locale usage.static void*
setLocaleMapping<../../../../com/ibm/icu/util/GenderInfo.html#setLocaleMapping(java.util.Map)>
*(java.util.Map<com.ibm.icu.util.ULocale,GenderInfo<../../../../com/ibm/icu/util/GenderInfo.html>
> newULocaleToListGender)
          Reset the data used for mapping locales to styles. *Methods
inherited from class java.lang.Object*equals, getClass, hashCode, notify,
notifyAll, toString, wait, wait, wait

*Constructor Detail*GenderInfo

public *GenderInfo*(GenderInfo.ListGenderStyle
<../../../../com/ibm/icu/util/GenderInfo.ListGenderStyle.html>
genderStyle)

Only for testing and use with CLDR.

*Parameters:*genderStyle - gender style*Method Detail*getInstance

public static GenderInfo
<../../../../com/ibm/icu/util/GenderInfo.html>
*getInstance*(com.ibm.icu.util.ULocale uLocale)

Create GenderInfo from a ULocale.

*Parameters:*uLocale - desired locale
------------------------------
getInstance

public static GenderInfo
<../../../../com/ibm/icu/util/GenderInfo.html>
*getInstance*(java.util.Locale locale)

Create GenderInfo from a Locale.

*Parameters:*locale - desired locale
------------------------------
setLocaleMapping

public static void
*setLocaleMapping*(java.util.Map<com.ibm.icu.util.ULocale,GenderInfo
<../../../../com/ibm/icu/util/GenderInfo.html>>
newULocaleToListGender)

Reset the data used for mapping locales to styles. Only for use in CLDR and
in testing!

*Parameters:*newULocaleToListGender - replacement data, copied internally
for safety.
------------------------------
getListGender

public GenderInfo.Gender
<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
*getListGender*(GenderInfo.Gender
<../../../../com/ibm/icu/util/GenderInfo.Gender.html>... genders)

Get the gender of a list, based on locale usage.

*Parameters:*genders - a list of genders.*Returns:*the gender of the list.
------------------------------
getListGender

public GenderInfo.Gender
<../../../../com/ibm/icu/util/GenderInfo.Gender.html>
*getListGender*(java.util.List<GenderInfo.Gender
<../../../../com/ibm/icu/util/GenderInfo.Gender.html>> genders)

Get the gender of a list, based on locale usage.

*Parameters:*genders - a list of genders.*Returns:*the gender of the list.

public static enum *GenderInfo.Gender*extends
java.lang.Enum<GenderInfo.Gender
<../../../../com/ibm/icu/util/GenderInfo.Gender.html>>

Gender: OTHER means either the information is unavailable, or the person
has declined to state MALE or FEMALE.

------------------------------

*Enum Constant Summary**FEMALE<../../../../com/ibm/icu/util/GenderInfo.Gender.html#FEMALE>
*
           *MALE <../../../../com/ibm/icu/util/GenderInfo.Gender.html#MALE>*

           *OTHER<../../../../com/ibm/icu/util/GenderInfo.Gender.html#OTHER>
*

------------------------------
Mark <https://plus.google.com/114199149796022210033>
*
*
*— Il meglio è l’inimico del bene —*
**