PluralFormat

PluralFormat

public PluralFormat ()

Creates a new cardinal-number PluralFormat for the default FORMAT locale. This locale will be used to get the set of plural rules and for standard number formatting.

PluralFormat

public PluralFormat (ULocale ulocale)

Creates a new cardinal-number PluralFormat for a given locale.

PluralFormat

public PluralFormat (Locale locale)

Creates a new cardinal-number PluralFormat for a given Locale.

PluralFormat

public PluralFormat (PluralRules rules)

Creates a new cardinal-number PluralFormat for a given set of rules. The standard number formatting will be done using the default FORMAT locale.

PluralFormat

public PluralFormat (ULocale ulocale, 
                PluralRules rules)

Creates a new cardinal-number PluralFormat for a given set of rules. The standard number formatting will be done using the given locale.

PluralFormat

public PluralFormat (Locale locale, 
                PluralRules rules)

Creates a new cardinal-number PluralFormat for a given set of rules. The standard number formatting will be done using the given locale.

PluralFormat

public PluralFormat (ULocale ulocale, 
                PluralRules.PluralType type)

Creates a new PluralFormat for the plural type. The standard number formatting will be done using the given locale.

PluralFormat

public PluralFormat (Locale locale, 
                PluralRules.PluralType type)

Creates a new PluralFormat for the plural type. The standard number formatting will be done using the given Locale.

PluralFormat

public PluralFormat (String pattern)

Creates a new cardinal-number PluralFormat for a given pattern string. The default FORMAT locale will be used to get the set of plural rules and for standard number formatting.

PluralFormat

public PluralFormat (ULocale ulocale, 
                String pattern)

Creates a new cardinal-number PluralFormat for a given pattern string and locale. The locale will be used to get the set of plural rules and for standard number formatting.

Example code:

ULocale locEn = new ULocale("en");
ULocale locSl = new ULocale("sl");

String patEn = "one{dog} other{dogs}";                      // English 'dog'
String patSl = "one{pes} two{psa} few{psi} other{psov}";    // Slovenian translation of dog in Plural Form

// Create a new PluralFormat for a given locale locale and pattern string
PluralFormat plfmtEn = new PluralFormat(locEn, patEn);
PluralFormat plfmtSl = new PluralFormat(locSl, patSl);
// Constructs a MessageFormat for the specified locale and pattern.
MessageFormat msgfmtEn = new MessageFormat("{0,number} {1}", locEn);
MessageFormat msgfmtSl = new MessageFormat("{0,number} {1}", locSl);

final int[] numbers = {0, 1, 2, 3, 4, 5, 10, 100, 101, 102};
System.out.println("Output by using PluralFormat and MessageFormat API\n");
System.out.printf("%-16s%-16s%-16s\n", "Number", "English", "Slovenian");

// Use MessageFormat.format () to format the objects and appends to the given StringBuffer
for (int num : numbers) {
    StringBuffer msgEn = new StringBuffer();
    StringBuffer msgSl = new StringBuffer();

    msgfmtEn.format(new Object[] {num, plfmtEn.format(num)}, msgEn, new FieldPosition(0));
    msgfmtSl.format(new Object[] {num, plfmtSl.format(num)}, msgSl, new FieldPosition(0));

    System.out.printf("%-16s%-16s%-16s\n", num, msgEn, msgSl);
}

System.out.println();

// Equivalent code with message format pattern
String msgPatEn = "{0,plural, one{# dog} other{# dogs}}";
String msgPatSl = "{0,plural, one{# pes} two{# psa} few{# psi} other{# psov}}";

MessageFormat altMsgfmtEn = new MessageFormat(msgPatEn, locEn);
MessageFormat altMsgfmtSl = new MessageFormat(msgPatSl, locSl);
System.out.println("Same Output by using MessageFormat API only\n");
System.out.printf("%-16s%-16s%-16s\n", "Number", "English", "Slovenian");
for (int num : numbers) {
    StringBuffer msgEn = new StringBuffer();
    StringBuffer msgSl = new StringBuffer();

    altMsgfmtEn.format(new Object[] {num}, msgEn, new FieldPosition(0));
    altMsgfmtSl.format(new Object[] {num}, msgSl, new FieldPosition(0));

    System.out.printf("%-16s%-16s%-16s\n", num, msgEn, msgSl);
}
/** output of the sample code:
 ********************************************************************
  Number          English         Slovenian
  0               0 dogs          0 psov
  1               1 dog           1 pes
  2               2 dogs          2 psa
  3               3 dogs          3 psi
  4               4 dogs          4 psi
  5               5 dogs          5 psov
  10              10 dogs         10 psov
  100             100 dogs        100 psov
  101             101 dogs        101 pes
  102             102 dogs        102 psa

 *******************************************************************/

PluralFormat

public PluralFormat (PluralRules rules, 
                String pattern)

Creates a new cardinal-number PluralFormat for a given set of rules and a pattern. The standard number formatting will be done using the default FORMAT locale.

PluralFormat

public PluralFormat (ULocale ulocale, 
                PluralRules rules, 
                String pattern)

Creates a new cardinal-number PluralFormat for a given set of rules, a pattern and a locale.

PluralFormat

public PluralFormat (ULocale ulocale, 
                PluralRules.PluralType type, 
                String pattern)

Creates a new PluralFormat for a plural type, a pattern and a locale.

applyPattern

public void applyPattern (String pattern)

Sets the pattern used by this plural format. The method parses the pattern and creates a map of format strings for the plural rules. Patterns and their interpretation are specified in the class description.

equals

public boolean equals (Object rhs)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

equals

public boolean equals (PluralFormat rhs)

Returns true if this equals the provided PluralFormat.

format

public final String format (double number)

Formats a plural message for a given number.

format

public StringBuffer format (Object number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Formats a plural message for a given number and appends the formatted message to the given StringBuffer.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

parse

public Number parse (String text, 
                ParsePosition parsePosition)

This method is not yet supported by PluralFormat.

parseObject

public Object parseObject (String source, 
                ParsePosition pos)

This method is not yet supported by PluralFormat.

setNumberFormat

public void setNumberFormat (NumberFormat format)

Sets the number format used by this formatter. You only need to call this if you want a different number format than the default formatter for the locale.

toPattern

public String toPattern ()

Returns the pattern for this PluralFormat.

toString

public String toString ()

Returns a string representation of the object.