OSDN Git Service

* java/text/SimpleDateFormat.java: Re-merged with Classpath.
[pf3gnuchains/gcc-fork.git] / libjava / java / text / Format.java
1 /* Format.java -- Abstract superclass for formatting/parsing strings.
2    Copyright (C) 1998, 1999, 2000, 2001 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 As a special exception, if you link this library with other files to
22 produce an executable, this library does not by itself cause the
23 resulting executable to be covered by the GNU General Public License.
24 This exception does not however invalidate any other reasons why the
25 executable file might be covered by the GNU General Public License. */
26
27
28 package java.text;
29
30 import java.io.Serializable;
31
32 /**
33  * This class is the abstract superclass of classes that format and parse
34  * data to/from <code>Strings</code>.  It is guaranteed that any 
35  * <code>String</code> produced by a concrete subclass of <code>Format</code>
36  * will be parseable by that same subclass.
37  * <p>
38  * In addition to implementing the abstract methods in this class, subclasses
39  * should provide static factory methods of the form 
40  * <code>getInstance()</code> and <code>getInstance(Locale)</code> if the
41  * subclass loads different formatting/parsing schemes based on locale.
42  * These subclasses should also implement a static method called
43  * <code>getAvailableLocales()</code> which returns an array of 
44  * available locales in the current runtime environment.
45  *
46  * @author Aaron M. Renn (arenn@urbanophile.com)
47  * @author Per Bothner <bothner@cygnus.com>
48  */
49 public abstract class Format implements Serializable, Cloneable
50 {
51   /**
52    * This method initializes a new instance of <code>Format</code>.
53    * It performs no actions, but acts as a default constructor for
54    * subclasses.
55    */
56   public Format ()
57   {
58   }
59
60   /**
61    * This method formats an <code>Object</code> into a <code>String</code>.
62    * 
63    * @param obj The <code>Object</code> to format.
64    *
65    * @return The formatted <code>String</code>.
66    *
67    * @exception IllegalArgumentException If the <code>Object</code>
68    * cannot be formatted. 
69    */
70   public final String format(Object obj) throws IllegalArgumentException
71   {
72     StringBuffer sb = new StringBuffer ();
73     format (obj, sb, new FieldPosition (0));
74     return sb.toString ();
75   }
76
77   /**
78    * This method formats an <code>Object</code> into a <code>String</code> and
79    * appends the <code>String</code> to a <code>StringBuffer</code>.
80    *
81    * @param obj The <code>Object</code> to format.
82    * @param sb The <code>StringBuffer</code> to append to.
83    * @param pos The desired <code>FieldPosition</code>, which is also
84    *            updated by this call. 
85    *
86    * @return The updated <code>StringBuffer</code>.
87    *
88    * @exception IllegalArgumentException If the <code>Object</code>
89    * cannot be formatted. 
90    */
91   public abstract StringBuffer format (Object obj, StringBuffer sb,
92                                        FieldPosition pos)
93     throws IllegalArgumentException;
94
95   /**
96    * This method parses a <code>String</code> and converts the parsed 
97    * contents into an <code>Object</code>.
98    *
99    * @param str The <code>String to parse.
100    *
101    * @return The resulting <code>Object</code>.
102    *
103    * @exception ParseException If the <code>String</code> cannot be parsed.
104    */
105   public Object parseObject (String str) throws ParseException
106   {
107     ParsePosition pos = new ParsePosition(0);
108     Object result = parseObject (str, pos);
109     if (result == null)
110       {
111         int index = pos.getErrorIndex();
112         if (index < 0)
113           index = pos.getIndex();
114         throw new ParseException("parseObject failed", index);
115       }
116     return result;
117   }
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    * @param pos The starting parse index on input, the ending parse
125    *            index on output. 
126    *
127    * @return The parsed <code>Object</code>, or <code>null</code> in
128    *         case of error.
129    */
130   public abstract Object parseObject (String str, ParsePosition pos);
131
132   /**
133    * Creates a copy of this object.
134    *
135    * @return The copied <code>Object</code>.
136    */
137   public Object clone ()
138   {
139     try
140       {
141         return super.clone ();
142       }
143     catch (CloneNotSupportedException e)
144       {
145         return null;
146       }
147   }
148 }