KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > vfs > i18n > EncodingWriter


1 /*
2  * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3  *
4  * This file is part of Resin(R) Open Source
5  *
6  * Each copy or derived work must preserve the copyright notice and this
7  * notice unmodified.
8  *
9  * Resin Open Source is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Resin Open Source is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17  * of NON-INFRINGEMENT. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Resin Open Source; if not, write to the
22  * Free SoftwareFoundation, Inc.
23  * 59 Temple Place, Suite 330
24  * Boston, MA 02111-1307 USA
25  *
26  * @author Scott Ferguson
27  */
28
29 package com.caucho.vfs.i18n;
30
31 import com.caucho.vfs.OutputStreamWithBuffer;
32
33 import java.io.IOException JavaDoc;
34 import java.util.logging.Logger JavaDoc;
35
36 /**
37  * Abstract class for a character-to-byte encoding writer.
38  *
39  * <p/>Implementations need to implement <code>create</code>
40  * and <code>write()</code> at minimum. Efficient implementations will
41  * also implement the <code>write</code> into a buffer.
42  *
43  * <p/>Implementations should not buffer the bytes.
44  */
45 abstract public class EncodingWriter {
46   protected static final Logger JavaDoc log
47     = Logger.getLogger(EncodingWriter.class.getName());
48   
49   /**
50    * Returns the Java encoding for the writer.
51    */
52   public String JavaDoc getJavaEncoding()
53   {
54     return "unknown";
55   }
56   
57   /**
58    * Sets the Java encoding for the writer.
59    */
60   public void setJavaEncoding(String JavaDoc encoding)
61   {
62   }
63   
64   /**
65    * Returns a new encoding writer for the given stream and javaEncoding.
66    *
67    * @param javaEncoding the JDK name for the encoding.
68    *
69    * @return the encoding writer
70    */
71   public abstract EncodingWriter create(String JavaDoc javaEncoding);
72   
73   /**
74    * Returns a new encoding writer using the saved writer.
75    *
76    * @return the encoding writer
77    */
78   public EncodingWriter create()
79   {
80     return create(getJavaEncoding());
81   }
82
83   /**
84    * Writes the next character using the correct encoding.
85    *
86    * @param ch the character to write
87    */
88   public abstract void write(OutputStreamWithBuffer os, char ch)
89     throws IOException JavaDoc;
90
91   /**
92    * Writes a character buffer using the correct encoding.
93    *
94    * @param cbuf character buffer receiving the data.
95    * @param off starting offset into the buffer.
96    * @param len number of characters to write
97    */
98   public void write(OutputStreamWithBuffer os, char []cbuf, int off, int len)
99     throws IOException JavaDoc
100   {
101     for (int i = 0; i < len; i++)
102       write(os, cbuf[off + i]);
103   }
104 }
105
Popular Tags