libjava/java/text/Format.java

   1 /* Format.java -- Abstract superclass for formatting/parsing strings.
   2    Copyright (C) 1998, 1999, 2000, 2001, 2003  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.text;
  40
  41 import gnu.java.text.FormatCharacterIterator;
  42 import java.io.Serializable;
  43
  44 /**
  45  * This class is the abstract superclass of classes that format and parse
  46  * data to/from <code>Strings</code>.  It is guaranteed that any
  47  * <code>String</code> produced by a concrete subclass of <code>Format</code>
  48  * will be parseable by that same subclass.
  49  * <p>
  50  * In addition to implementing the abstract methods in this class, subclasses
  51  * should provide static factory methods of the form
  52  * <code>getInstance()</code> and <code>getInstance(Locale)</code> if the
  53  * subclass loads different formatting/parsing schemes based on locale.
  54  * These subclasses should also implement a static method called
  55  * <code>getAvailableLocales()</code> which returns an array of
  56  * available locales in the current runtime environment.
  57  *
  58  * @author Aaron M. Renn (arenn@urbanophile.com)
  59  * @author Per Bothner <bothner@cygnus.com>
  60  */
  61 public abstract class Format implements Serializable, Cloneable
  62 {
  63   static final long serialVersionUID = -299282585814624189L;
  64
  65   public static class Field extends AttributedCharacterIterator.Attribute
  66   {
  67     static final long serialVersionUID = 276966692217360283L;
  68
  69     public Field(String name)
  70     {
  71       super(name);
  72     }
  73   }
  74
  75   /**
  76    * This method initializes a new instance of <code>Format</code>.
  77    * It performs no actions, but acts as a default constructor for
  78    * subclasses.
  79    */
  80   public Format ()
  81   {
  82   }
  83
  84   /**
  85    * This method formats an <code>Object</code> into a <code>String</code>.
  86    *
  87    * @param obj The <code>Object</code> to format.
  88    *
  89    * @return The formatted <code>String</code>.
  90    *
  91    * @exception IllegalArgumentException If the <code>Object</code>
  92    * cannot be formatted.
  93    */
  94   public final String format(Object obj) throws IllegalArgumentException
  95   {
  96     StringBuffer sb = new StringBuffer ();
  97     format (obj, sb, new FieldPosition (0));
  98     return sb.toString ();
  99   }
 100
 101   /**
 102    * This method formats an <code>Object</code> into a <code>String</code> and
 103    * appends the <code>String</code> to a <code>StringBuffer</code>.
 104    *
 105    * @param obj The <code>Object</code> to format.
 106    * @param sb The <code>StringBuffer</code> to append to.
 107    * @param pos The desired <code>FieldPosition</code>, which is also
 108    *            updated by this call.
 109    *
 110    * @return The updated <code>StringBuffer</code>.
 111    *
 112    * @exception IllegalArgumentException If the <code>Object</code>
 113    * cannot be formatted.
 114    */
 115   public abstract StringBuffer format (Object obj, StringBuffer sb,
 116                                        FieldPosition pos)
 117     throws IllegalArgumentException;
 118
 119   /**
 120    * This method parses a <code>String</code> and converts the parsed
 121    * contents into an <code>Object</code>.
 122    *
 123    * @param str The <code>String</code> to parse.
 124    *
 125    * @return The resulting <code>Object</code>.
 126    *
 127    * @exception ParseException If the <code>String</code> cannot be parsed.
 128    */
 129   public Object parseObject (String str) throws ParseException
 130   {
 131     ParsePosition pos = new ParsePosition(0);
 132     Object result = parseObject (str, pos);
 133     if (result == null)
 134       {
 135         int index = pos.getErrorIndex();
 136         if (index < 0)
 137           index = pos.getIndex();
 138         throw new ParseException("parseObject failed", index);
 139       }
 140     return result;
 141   }
 142
 143   /**
 144    * This method parses a <code>String</code> and converts the parsed
 145    * contents into an <code>Object</code>.
 146    *
 147    * @param str The <code>String</code> to parse.
 148    * @param pos The starting parse index on input, the ending parse
 149    *            index on output.
 150    *
 151    * @return The parsed <code>Object</code>, or <code>null</code> in
 152    *         case of error.
 153    */
 154   public abstract Object parseObject (String str, ParsePosition pos);
 155
 156   public AttributedCharacterIterator formatToCharacterIterator(Object obj)
 157   {
 158     return new FormatCharacterIterator(format(obj), null, null);
 159   }
 160
 161   /**
 162    * Creates a copy of this object.
 163    *
 164    * @return The copied <code>Object</code>.
 165    */
 166   public Object clone ()
 167   {
 168     try
 169       {
 170         return super.clone ();
 171       }
 172     catch (CloneNotSupportedException e)
 173       {
 174         return null;
 175       }
 176   }
 177 }