NumberFormat.java 28.7 KB
Newer Older
Tom Tromey committed
1
/* NumberFormat.java -- Formats and parses numbers
2 3
   Copyright (C) 1998, 1999, 2000, 2001, 2003, 2004, 2007
   Free Software Foundation, Inc.
Tom Tromey committed
4 5 6 7 8 9 10

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
11

Tom Tromey committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.text;

42 43
import gnu.java.locale.LocaleHelper;

Tom Tromey committed
44 45 46 47
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
48 49 50

import java.text.spi.NumberFormatProvider;

Tom Tromey committed
51 52 53 54
import java.util.Currency;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
55
import java.util.ServiceLoader;
Tom Tromey committed
56 57

/**
58
 * This is the abstract superclass of all classes which format and
Tom Tromey committed
59 60 61 62 63 64 65
 * parse numeric values such as decimal numbers, integers, currency values,
 * and percentages.  These classes perform their parsing and formatting
 * in a locale specific manner, accounting for such items as differing
 * currency symbols and thousands separators.
 * <p>
 * To create an instance of a concrete subclass of <code>NumberFormat</code>,
 * do not call a class constructor directly.  Instead, use one of the
66
 * static factory methods in this class such as
Tom Tromey committed
67
 * <code>getCurrencyInstance</code>.
68
 *
Tom Tromey committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
 * @author Tom Tromey (tromey@cygnus.com)
 * @author Aaron M. Renn (arenn@urbanophile.com)
 * @date March 4, 1999
 */
/* Written using "Java Class Libraries", 2nd edition, plus online
 * API docs for JDK 1.2 from http://www.javasoft.com.
 * Status:  Believed complete and correct to 1.2, except getAvailableLocales.
 */
public abstract class NumberFormat extends Format implements Cloneable
{
  /**
   * This is a constant used to create a <code>FieldPosition</code> object
   * that will return the integer portion of a formatted number.
   */
  public static final int INTEGER_FIELD = 0;

  /**
   * This is a constant used to create a <code>FieldPosition</code> object
   * that will return the fractional portion of a formatted number.
   */
  public static final int FRACTION_FIELD = 1;

  public static class Field extends Format.Field
  {
    static final long serialVersionUID = 7494728892700160890L;

    /**
     * Attribute set to all characters containing digits of the integer
     * part.
     */
    public static final NumberFormat.Field INTEGER
      = new Field("integer");

    /**
     * Attribute set to all characters containing digits of the fractional
     * part.
     */
    public static final NumberFormat.Field FRACTION
      = new Field("fraction");

    /**
     * Attribute set to all characters containing digits of the exponential
     * part.
     */
    public static final NumberFormat.Field EXPONENT
      = new Field("exponent");

    /**
     * Attribute set to all characters containing a decimal separator.
     */
    public static final NumberFormat.Field DECIMAL_SEPARATOR
      = new Field("decimal separator");

    /**
     * Attribute set to all characters containing a sign (plus or minus).
     */
    public static final NumberFormat.Field SIGN
      = new Field("sign");

    /**
     * Attribute set to all characters containing a grouping separator (e.g.
     * a comma, a white space,...).
     */
    public static final NumberFormat.Field GROUPING_SEPARATOR
      = new Field("grouping separator");

    /**
     * Attribute set to all characters containing an exponential symbol (e.g.
     * 'E')
     */
    public static final NumberFormat.Field EXPONENT_SYMBOL
      = new Field("exponent symbol");

    /**
     * Attribute set to all characters containing a percent symbol (e.g. '%')
     */
    public static final NumberFormat.Field PERCENT
      = new Field("percent");

    /**
     * Attribute set to all characters containing a permille symbol.
     */
    public static final NumberFormat.Field PERMILLE
      = new Field("permille");

    /**
     * Attribute set to all characters containing the currency unit.
     */
    public static final NumberFormat.Field CURRENCY
      = new Field("currency");

    /**
     * Attribute set to all characters containing the exponent sign.
     */
    public static final NumberFormat.Field EXPONENT_SIGN
      = new Field("exponent sign");

    /**
     * Private fields to register all fields contained in this descriptor.
     */
    private static final NumberFormat.Field[] allFields =
    {
      INTEGER, FRACTION, EXPONENT, DECIMAL_SEPARATOR, SIGN,
      GROUPING_SEPARATOR, EXPONENT_SYMBOL, PERCENT,
      PERMILLE, CURRENCY, EXPONENT_SIGN
    };

    /**
     * This constructor is only used by the deserializer. Without it,
     * it would fail to construct a valid object.
     */
180
    @SuppressWarnings("unused")
Tom Tromey committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    private Field()
    {
      super("");
    }

    /**
     * Create a Field instance with the specified field name.
     *
     * @param field_name Field name for the new Field instance.
     */
    protected Field(String field_name)
    {
      super (field_name);
    }

    /**
     * This function is used by the deserializer to know which object
198
     * to use when it encounters an encoded NumberFormat.Field in a
Tom Tromey committed
199 200 201 202 203 204 205 206 207 208 209
     * serialization stream. If the stream is valid it should return
     * one of the above field. In the other case we throw an exception.
     *
     * @return a valid official NumberFormat.Field instance.
     *
     * @throws InvalidObjectException if the field name is invalid.
     */
    protected Object readResolve() throws InvalidObjectException
    {
      String s = getName();
      for (int i = 0; i < allFields.length; i++)
210 211
        if (s.equals(allFields[i].getName()))
          return allFields[i];
Tom Tromey committed
212 213

      throw new InvalidObjectException("no such NumberFormat field called "
214
                                       + s);
Tom Tromey committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228
    }
  }

  /**
   * This method is a specialization of the format method that performs
   * a simple formatting of the specified <code>long</code> number.
   *
   * @param number The <code>long</code> to format.
   *
   * @return The formatted number
   */
  public final String format (long number)
  {
    StringBuffer sbuf = new StringBuffer(50);
229
    format (number, sbuf, new FieldPosition(0));
Tom Tromey committed
230 231 232
    return sbuf.toString();
  }

233 234 235 236 237
  /**
   * @specnote this method was final in releases before 1.5
   */
  public StringBuffer format (Object obj, StringBuffer sbuf,
                              FieldPosition pos)
Tom Tromey committed
238 239 240
  {
    if (obj instanceof Number)
      return format(((Number) obj).doubleValue(), sbuf, pos);
241

242 243
    throw new
      IllegalArgumentException("Cannot format given Object as a Number");
Tom Tromey committed
244 245 246 247 248
  }

  /**
   * This method formats the specified <code>double</code> and appends it to
   * a <code>StringBuffer</code>.
249
   *
Tom Tromey committed
250
   * @param number The <code>double</code> to format.
251
   * @param sbuf The <code>StringBuffer</code> to append the formatted number
Tom Tromey committed
252
   *             to.
Tom Tromey committed
253 254 255 256 257
   * @param pos The desired <code>FieldPosition</code>.
   *
   * @return The <code>StringBuffer</code> with the appended number.
   */
  public abstract StringBuffer format (double number,
258
                                       StringBuffer sbuf, FieldPosition pos);
Tom Tromey committed
259 260 261 262

  /**
   * This method formats the specified <code>long</code> and appends it to
   * a <code>StringBuffer</code>.
263
   *
Tom Tromey committed
264
   * @param number The <code>long</code> to format.
265
   * @param sbuf The <code>StringBuffer</code> to append the formatted number
Tom Tromey committed
266
   *             to.
Tom Tromey committed
267 268 269 270 271
   * @param pos The desired <code>FieldPosition</code>.
   *
   * @return The <code>StringBuffer</code> with the appended number.
   */
  public abstract StringBuffer format (long number,
272
                                       StringBuffer sbuf, FieldPosition pos);
Tom Tromey committed
273 274 275 276 277 278 279 280 281 282

  /**
   * This method tests the specified object for equality against this object.
   * This will be <code>true</code> if the following conditions are met:
   * <p>
   * <ul>
   * <li>The specified object is not <code>null</code>.
   * <li>The specified object is an instance of <code>NumberFormat</code>.
   * </ul>
   * <p>
283
   * Since this method does not test much, it is highly advised that
Tom Tromey committed
284 285 286
   * concrete subclasses override this method.
   *
   * @param obj The <code>Object</code> to test against equality with
287 288
   *            this object.
   *
Tom Tromey committed
289
   * @return <code>true</code> if the specified object is equal to
290
   * this object, <code>false</code> otherwise.
Tom Tromey committed
291 292 293 294 295 296 297
   */
  public boolean equals (Object obj)
  {
    if (! (obj instanceof NumberFormat))
      return false;
    NumberFormat nf = (NumberFormat) obj;
    return (groupingUsed == nf.groupingUsed
298 299 300 301 302
            && maximumFractionDigits == nf.maximumFractionDigits
            && maximumIntegerDigits == nf.maximumIntegerDigits
            && minimumFractionDigits == nf.minimumFractionDigits
            && minimumIntegerDigits == nf.minimumIntegerDigits
            && parseIntegerOnly == nf.parseIntegerOnly);
Tom Tromey committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  }

  /**
   * This method returns a list of locales for which concrete instances
   * of <code>NumberFormat</code> subclasses may be created.
   *
   * @return The list of available locales.
   */
  public static Locale[] getAvailableLocales ()
  {
    Locale[] list = new Locale[1];
    list[0] = Locale.US;
    return list;
  }

  private static NumberFormat computeInstance(Locale loc, String resource,
                                              String def)
320
    throws MissingResourceException
Tom Tromey committed
321
  {
322
    if (loc.equals(Locale.ROOT))
323
      return new DecimalFormat(def, DecimalFormatSymbols.getInstance(loc));
324 325
    ResourceBundle res =
      ResourceBundle.getBundle("gnu.java.locale.LocaleInformation",
326
                               loc, ClassLoader.getSystemClassLoader());
Tom Tromey committed
327 328 329
    String fmt;
    try
      {
330
        fmt = res == null ? def : res.getString(resource);
Tom Tromey committed
331 332 333
      }
    catch (MissingResourceException x)
      {
334
        fmt = def;
Tom Tromey committed
335
      }
336
    DecimalFormatSymbols dfs = DecimalFormatSymbols.getInstance(loc);
Tom Tromey committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
    return new DecimalFormat (fmt, dfs);
  }

  /**
   * This method returns an instance of <code>NumberFormat</code> suitable
   * for formatting and parsing currency values in the default locale.
   *
   * @return An instance of <code>NumberFormat</code> for handling currencies.
   */
  public static final NumberFormat getCurrencyInstance ()
  {
    return getCurrencyInstance (Locale.getDefault());
  }

  /**
   * This method returns an instance of <code>NumberFormat</code> suitable
   * for formatting and parsing currency values in the specified locale.
   *
   * @return An instance of <code>NumberFormat</code> for handling currencies.
   */
  public static NumberFormat getCurrencyInstance (Locale loc)
  {
359 360
    try
      {
361 362 363 364 365 366
        NumberFormat format;

        format = computeInstance (loc, "currencyFormat",
                                  "\u00A4#,##0.00;(\u00A4#,##0.00)");
        format.setMaximumFractionDigits(format.getCurrency().getDefaultFractionDigits());
        return format;
367 368 369
      }
    catch (MissingResourceException e)
      {
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
        for (NumberFormatProvider p :
               ServiceLoader.load(NumberFormatProvider.class))
          {
            for (Locale l : p.getAvailableLocales())
              {
                if (l.equals(loc))
                  {
                    NumberFormat nf = p.getCurrencyInstance(loc);
                    if (nf != null)
                      return nf;
                    break;
                  }
              }
          }
        return getCurrencyInstance(LocaleHelper.getFallbackLocale(loc));
385
      }
Tom Tromey committed
386 387 388 389
  }

  /**
   * This method returns a default instance for the default locale. This
390
   * will be a concrete subclass of <code>NumberFormat</code>, but the
Tom Tromey committed
391 392 393 394 395 396 397 398 399 400 401
   * actual class returned is dependent on the locale.
   *
   * @return An instance of the default <code>NumberFormat</code> class.
   */
  public static final NumberFormat getInstance ()
  {
    return getInstance (Locale.getDefault());
  }

  /**
   * This method returns a default instance for the specified locale. This
402
   * will be a concrete subclass of <code>NumberFormat</code>, but the
Tom Tromey committed
403 404
   * actual class returned is dependent on the locale.
   *
Tom Tromey committed
405
   * @param loc The desired locale.
Tom Tromey committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419
   *
   * @return An instance of the default <code>NumberFormat</code> class.
   */
  public static NumberFormat getInstance (Locale loc)
  {
    // For now always return a number instance.
    return getNumberInstance (loc);
  }

  /**
   * This method returns the maximum number of digits allowed in the fraction
   * portion of a number.
   *
   * @return The maximum number of digits allowed in the fraction
420
   * portion of a number.
Tom Tromey committed
421 422 423 424 425 426 427 428 429 430 431
   */
  public int getMaximumFractionDigits ()
  {
    return maximumFractionDigits;
  }

  /**
   * This method returns the maximum number of digits allowed in the integer
   * portion of a number.
   *
   * @return The maximum number of digits allowed in the integer
432
   * portion of a number.
Tom Tromey committed
433 434 435 436 437 438 439 440 441 442 443
   */
  public int getMaximumIntegerDigits ()
  {
    return maximumIntegerDigits;
  }

  /**
   * This method returns the minimum number of digits allowed in the fraction
   * portion of a number.
   *
   * @return The minimum number of digits allowed in the fraction
444
   * portion of a number.
Tom Tromey committed
445 446 447 448 449 450 451 452 453 454 455
   */
  public int getMinimumFractionDigits ()
  {
    return minimumFractionDigits;
  }

  /**
   * This method returns the minimum number of digits allowed in the integer
   * portion of a number.
   *
   * @return The minimum number of digits allowed in the integer
456
   * portion of a number.
Tom Tromey committed
457 458 459 460 461 462 463 464
   */
  public int getMinimumIntegerDigits ()
  {
    return minimumIntegerDigits;
  }

  /**
   * This method returns a default instance for the specified locale. This
465
   * will be a concrete subclass of <code>NumberFormat</code>, but the
Tom Tromey committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
   * actual class returned is dependent on the locale.
   *
   * @return An instance of the default <code>NumberFormat</code> class.
   */
  public static final NumberFormat getNumberInstance ()
  {
    return getNumberInstance (Locale.getDefault());
  }

  /**
   * This method returns a general purpose number formatting and parsing
   * class for the default locale.  This will be a concrete subclass of
   * <code>NumberFormat</code>, but the actual class returned is dependent
   * on the locale.
   *
   * @return An instance of a generic number formatter for the default locale.
   */
  public static NumberFormat getNumberInstance (Locale loc)
  {
485 486
    try
      {
487
        return computeInstance (loc, "numberFormat", "#,##0.###");
488 489 490
      }
    catch (MissingResourceException e)
      {
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
        for (NumberFormatProvider p :
               ServiceLoader.load(NumberFormatProvider.class))
          {
            for (Locale l : p.getAvailableLocales())
              {
                if (l.equals(loc))
                  {
                    NumberFormat nf = p.getNumberInstance(loc);
                    if (nf != null)
                      return nf;
                    break;
                  }
              }
          }
        return getNumberInstance(LocaleHelper.getFallbackLocale(loc));
506
      }
Tom Tromey committed
507 508 509 510 511 512 513 514
  }

  /**
   * This method returns an integer formatting and parsing class for the
   * default locale. This will be a concrete subclass of <code>NumberFormat</code>,
   * but the actual class returned is dependent on the locale.
   *
   * @return An instance of an integer number formatter for the default locale.
515
   * @since 1.4
Tom Tromey committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529
   */
  public static final NumberFormat getIntegerInstance()
  {
    return getIntegerInstance (Locale.getDefault());
  }

  /**
   * This method returns an integer formatting and parsing class for the
   * default locale. This will be a concrete subclass of <code>NumberFormat</code>,
   * but the actual class returned is dependent on the locale.
   *
   * @param locale the desired locale.
   *
   * @return An instance of an integer number formatter for the desired locale.
530
   * @since 1.4
Tom Tromey committed
531 532 533
   */
  public static NumberFormat getIntegerInstance(Locale locale)
  {
534 535
    try
      {
536 537 538 539 540
        NumberFormat format = computeInstance (locale,
                                               "integerFormat", "#,##0");
        format.setMaximumFractionDigits(0);
        format.setParseIntegerOnly (true);
        return format;
541 542 543
      }
    catch (MissingResourceException e)
      {
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
        for (NumberFormatProvider p :
               ServiceLoader.load(NumberFormatProvider.class))
          {
            for (Locale l : p.getAvailableLocales())
              {
                if (l.equals(locale))
                  {
                    NumberFormat nf = p.getIntegerInstance(locale);
                    if (nf != null)
                      return nf;
                    break;
                  }
              }
          }
        return getIntegerInstance(LocaleHelper.getFallbackLocale(locale));
559
      }
Tom Tromey committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
  }

  /**
   * This method returns an instance of <code>NumberFormat</code> suitable
   * for formatting and parsing percentage values in the default locale.
   *
   * @return An instance of <code>NumberFormat</code> for handling percentages.
   */
  public static final NumberFormat getPercentInstance ()
  {
    return getPercentInstance (Locale.getDefault());
  }

  /**
   * This method returns an instance of <code>NumberFormat</code> suitable
   * for formatting and parsing percentage values in the specified locale.
   *
Tom Tromey committed
577
   * @param loc The desired locale.
Tom Tromey committed
578 579 580 581 582
   *
   * @return An instance of <code>NumberFormat</code> for handling percentages.
   */
  public static NumberFormat getPercentInstance (Locale loc)
  {
583 584
    try
      {
585
        return computeInstance (loc, "percentFormat", "#,##0%");
586 587 588
      }
    catch (MissingResourceException e)
      {
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
        for (NumberFormatProvider p :
               ServiceLoader.load(NumberFormatProvider.class))
          {
            for (Locale l : p.getAvailableLocales())
              {
                if (l.equals(loc))
                  {
                    NumberFormat nf = p.getPercentInstance(loc);
                    if (nf != null)
                      return nf;
                    break;
                  }
              }
          }
        return getPercentInstance(LocaleHelper.getFallbackLocale(loc));
604
      }
Tom Tromey committed
605 606 607 608 609 610 611 612 613 614 615
  }

  /**
   * This method returns a hash value for this object.
   *
   * @return The hash code.
   */
  public int hashCode ()
  {
    int hash = super.hashCode();
    hash ^= (maximumFractionDigits + maximumIntegerDigits
616
             + minimumFractionDigits + minimumIntegerDigits);
Tom Tromey committed
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
    if (groupingUsed)
      hash ^= 0xf0f0;
    if (parseIntegerOnly)
      hash ^= 0x0f0f;
    return hash;
  }

  /**
   * This method tests whether or not grouping is in use.  Grouping is
   * a method of marking separations in numbers, such as thousand separators
   * in the US English locale.  The grouping positions and symbols are all
   * locale specific.  As an example, with grouping disabled, the number one
   * million would appear as "1000000".  With grouping enabled, this number
   * might appear as "1,000,000".  (Both of these assume the US English
   * locale).
   *
   * @return <code>true</code> if grouping is enabled,
634
   * <code>false</code> otherwise.
Tom Tromey committed
635 636 637 638 639 640 641 642 643 644 645 646
   */
  public boolean isGroupingUsed ()
  {
    return groupingUsed;
  }

  /**
   * This method tests whether or not only integer values should be parsed.
   * If this class is parsing only integers, parsing stops at the decimal
   * point.
   *
   * @return <code>true</code> if only integers are parsed,
647
   * <code>false</code> otherwise.
Tom Tromey committed
648 649 650 651 652 653 654 655 656
   */
  public boolean isParseIntegerOnly ()
  {
    return parseIntegerOnly;
  }

  /**
   * This is a default constructor for use by subclasses.
   */
657
  protected NumberFormat ()
Tom Tromey committed
658 659 660 661 662 663 664 665 666
  {
  }

  /**
   * This method parses the specified string into a <code>Number</code>.  This
   * will be a <code>Long</code> if possible, otherwise it will be a
   * <code>Double</code>.    If no number can be parsed, no exception is
   * thrown.  Instead, the parse position remains at its initial index.
   *
Tom Tromey committed
667 668
   * @param sourceStr The string to parse.
   * @param pos The desired <code>ParsePosition</code>.
Tom Tromey committed
669 670 671 672 673 674 675 676 677 678 679
   *
   * @return The parsed <code>Number</code>
   */
  public abstract Number parse (String sourceStr, ParsePosition pos);

  /**
   * This method parses the specified string into a <code>Number</code>.  This
   * will be a <code>Long</code> if possible, otherwise it will be a
   * <code>Double</code>.  If no number can be parsed, an exception will be
   * thrown.
   *
Tom Tromey committed
680
   * @param sourceStr The string to parse.
Tom Tromey committed
681 682 683 684 685 686 687 688 689 690 691
   *
   * @return The parsed <code>Number</code>
   *
   * @exception ParseException If no number can be parsed.
   */
  public Number parse (String sourceStr) throws ParseException
  {
    ParsePosition pp = new ParsePosition (0);
    Number r = parse (sourceStr, pp);
    if (r == null)
      {
692 693 694 695
        int index = pp.getErrorIndex();
        if (index < 0)
          index = pp.getIndex();
        throw new ParseException ("couldn't parse number", index);
Tom Tromey committed
696 697 698 699 700 701 702 703 704 705
      }
    return r;
  }

  /**
   * This method parses the specified string into an <code>Object</code>.  This
   * will be a <code>Long</code> if possible, otherwise it will be a
   * <code>Double</code>.    If no number can be parsed, no exception is
   * thrown.  Instead, the parse position remains at its initial index.
   *
Tom Tromey committed
706 707
   * @param sourceStr The string to parse.
   * @param pos The desired <code>ParsePosition</code>.
Tom Tromey committed
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  *
  * @return The parsed <code>Object</code>
  */
  public final Object parseObject (String sourceStr, ParsePosition pos)
  {
    return parse (sourceStr, pos);
  }

  /**
   * This method sets the grouping behavior of this formatter.  Grouping is
   * a method of marking separations in numbers, such as thousand separators
   * in the US English locale.  The grouping positions and symbols are all
   * locale specific.  As an example, with grouping disabled, the number one
   * million would appear as "1000000".  With grouping enabled, this number
   * might appear as "1,000,000".  (Both of these assume the US English
   * locale).
   *
Tom Tromey committed
725
   * @param newValue <code>true</code> to enable grouping,
726
   *                     <code>false</code> to disable it.
Tom Tromey committed
727 728 729 730 731 732 733 734 735 736 737 738
   */
  public void setGroupingUsed (boolean newValue)
  {
    groupingUsed = newValue;
  }

  /**
   * This method sets the maximum number of digits allowed in the fraction
   * portion of a number to the specified value.  If this is less than the
   * current minimum allowed digits, the minimum allowed digits value will
   * be lowered to be equal to the new maximum allowed digits value.
   *
Tom Tromey committed
739
   * @param digits The new maximum fraction digits value.
Tom Tromey committed
740
   */
Tom Tromey committed
741
  public void setMaximumFractionDigits (int digits)
Tom Tromey committed
742
  {
Tom Tromey committed
743
    maximumFractionDigits = digits;
Tom Tromey committed
744 745 746 747 748 749 750 751 752 753
    if (getMinimumFractionDigits () > maximumFractionDigits)
      setMinimumFractionDigits (maximumFractionDigits);
  }

  /**
   * This method sets the maximum number of digits allowed in the integer
   * portion of a number to the specified value.  If this is less than the
   * current minimum allowed digits, the minimum allowed digits value will
   * be lowered to be equal to the new maximum allowed digits value.
   *
Tom Tromey committed
754
   * @param digits The new maximum integer digits value.
Tom Tromey committed
755
   */
Tom Tromey committed
756
  public void setMaximumIntegerDigits (int digits)
Tom Tromey committed
757
  {
Tom Tromey committed
758
    maximumIntegerDigits = digits;
Tom Tromey committed
759 760 761 762 763 764 765 766 767 768
    if (getMinimumIntegerDigits () > maximumIntegerDigits)
      setMinimumIntegerDigits (maximumIntegerDigits);
  }

  /**
   * This method sets the minimum number of digits allowed in the fraction
   * portion of a number to the specified value.  If this is greater than the
   * current maximum allowed digits, the maximum allowed digits value will
   * be raised to be equal to the new minimum allowed digits value.
   *
Tom Tromey committed
769
   * @param digits The new minimum fraction digits value.
Tom Tromey committed
770
   */
Tom Tromey committed
771
  public void setMinimumFractionDigits (int digits)
Tom Tromey committed
772
  {
Tom Tromey committed
773
    minimumFractionDigits = digits;
Tom Tromey committed
774 775 776 777 778 779 780 781 782 783
    if (getMaximumFractionDigits () < minimumFractionDigits)
      setMaximumFractionDigits (minimumFractionDigits);
  }

  /**
   * This method sets the minimum number of digits allowed in the integer
   * portion of a number to the specified value.  If this is greater than the
   * current maximum allowed digits, the maximum allowed digits value will
   * be raised to be equal to the new minimum allowed digits value.
   *
Tom Tromey committed
784
   * @param digits The new minimum integer digits value.
Tom Tromey committed
785
   */
Tom Tromey committed
786
  public void setMinimumIntegerDigits (int digits)
Tom Tromey committed
787
  {
Tom Tromey committed
788
    minimumIntegerDigits = digits;
Tom Tromey committed
789 790 791 792
    if (getMaximumIntegerDigits () < minimumIntegerDigits)
      setMaximumIntegerDigits (minimumIntegerDigits);
  }

793 794
  /**
   * This method sets the parsing behavior of this object to parse only
Tom Tromey committed
795 796
   * integers or not.
   *
Tom Tromey committed
797
   * @param value <code>true</code> to parse only integers,
798
   *                         <code>false</code> otherwise.
Tom Tromey committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
   */
  public void setParseIntegerOnly (boolean value)
  {
    parseIntegerOnly = value;
  }

  /**
   * This method is a specialization of the format method that performs
   * a simple formatting of the specified <code>double</code> number.
   *
   * @param number The <code>double</code> to format.
   *
   * @return The formatted number
   */
  public final String format (double number)
  {
    StringBuffer sbuf = new StringBuffer(50);
816
    FieldPosition position = new FieldPosition(0);
817

818
    format (number, sbuf, position);
Tom Tromey committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    return sbuf.toString();
  }

  // These field names are fixed by the serialization spec.
  boolean groupingUsed;
  int maximumFractionDigits;
  private byte maxFractionDigits;
  int maximumIntegerDigits;
  private byte maxIntegerDigits;
  int minimumFractionDigits;
  private byte minFractionDigits;
  int minimumIntegerDigits;
  private byte minIntegerDigits;
  boolean parseIntegerOnly;
  private int serialVersionOnStream;
  private static final long serialVersionUID = -2308460125733713944L;

  private void readObject(ObjectInputStream stream)
    throws IOException, ClassNotFoundException
  {
    stream.defaultReadObject();
    if (serialVersionOnStream < 1)
      {
        maximumFractionDigits = maxFractionDigits;
843 844 845 846
        maximumIntegerDigits = maxIntegerDigits;
        minimumFractionDigits = minFractionDigits;
        minimumIntegerDigits = minIntegerDigits;
        serialVersionOnStream = 1;
Tom Tromey committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
      }
  }

  private void writeObject(ObjectOutputStream stream) throws IOException
  {
    maxFractionDigits = maximumFractionDigits < Byte.MAX_VALUE ?
      (byte) maximumFractionDigits : Byte.MAX_VALUE;
    maxIntegerDigits = maximumIntegerDigits < Byte.MAX_VALUE ?
      (byte) maximumIntegerDigits : Byte.MAX_VALUE;
    minFractionDigits = minimumFractionDigits < Byte.MAX_VALUE ?
      (byte) minimumFractionDigits : Byte.MAX_VALUE;
    minIntegerDigits = minimumIntegerDigits < Byte.MAX_VALUE ?
      (byte) minimumIntegerDigits : Byte.MAX_VALUE;
    serialVersionOnStream = 1;
    stream.defaultWriteObject();
  }

  /**
   * Returns the currency used by this number format when formatting currency
   * values.
   *
   * The default implementation throws UnsupportedOperationException.
   *
   * @return The used currency object, or null.
   *
   * @throws UnsupportedOperationException If the number format class doesn't
   * implement currency formatting.
   *
   * @since 1.4
   */
  public Currency getCurrency()
  {
    throw new UnsupportedOperationException();
  }

  /**
   * Sets the currency used by this number format when formatting currency
   * values.
   *
   * The default implementation throws UnsupportedOperationException.
   *
   * @param currency The new currency to be used by this number format.
   *
   * @throws NullPointerException If currenc is null.
   * @throws UnsupportedOperationException If the number format class doesn't
   * implement currency formatting.
   *
   * @since 1.4
   */
  public void setCurrency(Currency currency)
  {
    if (currency == null)
      throw new NullPointerException("currency may not be null");
900

Tom Tromey committed
901 902 903
    throw new UnsupportedOperationException();
  }
}