com.fr.design.gui.syntax.io

类 UnicodeWriter

java.lang.Object

java.io.Writer

com.fr.design.gui.syntax.io.UnicodeWriter

所有已实现的接口:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class UnicodeWriter
extends java.io.Writer

Writes Unicode text to an output stream. If the specified encoding is a Unicode, then the text is preceded by the proper Unicode BOM. If it is any other encoding, this class behaves just like OutputStreamWriter. This class is here because Java's OutputStreamWriter apparently doesn't believe in writing BOMs.

For optimum performance, it is recommended that you wrap all instances of UnicodeWriter with a java.io.BufferedWriter.

版本:

0.7

作者:

Robert Futrell

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PROPERTY_WRITE_UTF8_BOM If this system property evaluates to "false", ignoring case, files written out as UTF-8 will not have a BOM written for them.

从类继承的字段 java.io.Writer

lock

构造器概要

构造器

构造器和说明
UnicodeWriter(java.io.File file, java.lang.String encoding) This is a utility constructor since the vast majority of the time, this class will be used to write Unicode files.
UnicodeWriter(java.io.OutputStream out, java.lang.String encoding) Creates a new writer.
UnicodeWriter(java.lang.String fileName, java.lang.String encoding) This is a utility constructor since the vast majority of the time, this class will be used to write Unicode files.

方法概要

方法

限定符和类型	方法和说明
void	close() Closes this writer.
void	flush() Flushes the stream.
java.lang.String	getEncoding() Returns the encoding being used to write this output stream (i.e., the encoding of the file).
static boolean	getWriteUtf8BOM() Returns whether UTF-8 files should have a BOM in them when written.
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(java.lang.String str, int off, int len) Writes a portion of a string.

从类继承的方法 java.io.Writer

append, append, append, write, write

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

PROPERTY_WRITE_UTF8_BOM

public static final java.lang.String PROPERTY_WRITE_UTF8_BOM

If this system property evaluates to "false", ignoring case, files written out as UTF-8 will not have a BOM written for them. Otherwise (even if the property is not set), UTF-8 files will have a BOM written.

另请参阅:

常量字段值

构造器详细资料

UnicodeWriter

public UnicodeWriter(java.lang.String fileName,
             java.lang.String encoding)
              throws java.io.UnsupportedEncodingException,
                     java.io.IOException

This is a utility constructor since the vast majority of the time, this class will be used to write Unicode files.

参数:

fileName - The file to which to write the Unicode output.

encoding - The encoding to use.

抛出:

java.io.UnsupportedEncodingException - If the specified encoding is not supported.

java.io.IOException - If an IO exception occurs.

UnicodeWriter

public UnicodeWriter(java.io.File file,
             java.lang.String encoding)
              throws java.io.UnsupportedEncodingException,
                     java.io.IOException

This is a utility constructor since the vast majority of the time, this class will be used to write Unicode files.

参数:

file - The file to which to write the Unicode output.

encoding - The encoding to use.

抛出:

java.io.UnsupportedEncodingException - If the specified encoding is not supported.

java.io.IOException - If an IO exception occurs.

UnicodeWriter

public UnicodeWriter(java.io.OutputStream out,
             java.lang.String encoding)
              throws java.io.UnsupportedEncodingException,
                     java.io.IOException

Creates a new writer.

参数:

out - The output stream to write.

encoding - The encoding to use.

抛出:

java.io.UnsupportedEncodingException - If the specified encoding is not supported.

java.io.IOException - If an IO exception occurs.

方法详细资料

close

public void close()
           throws java.io.IOException

Closes this writer.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在类中 java.io.Writer

抛出:

java.io.IOException - If an IO exception occurs.

flush

public void flush()
           throws java.io.IOException

Flushes the stream.

指定者:

flush 在接口中 java.io.Flushable

指定者:

flush 在类中 java.io.Writer

抛出:

java.io.IOException - If an IO exception occurs.

getEncoding

public java.lang.String getEncoding()

Returns the encoding being used to write this output stream (i.e., the encoding of the file).

返回:

The encoding of the stream.

getWriteUtf8BOM

public static boolean getWriteUtf8BOM()

Returns whether UTF-8 files should have a BOM in them when written.

返回:

Whether to write a BOM for UTF-8 files.

write

public void write(char[] cbuf,
         int off,
         int len)
           throws java.io.IOException

Writes a portion of an array of characters.

指定者:

write 在类中 java.io.Writer

参数:

cbuf - The buffer of characters.

off - The offset from which to start writing characters.

len - The number of characters to write.

抛出:

java.io.IOException - If an I/O error occurs.

write

public void write(int c)
           throws java.io.IOException

Writes a single character.

覆盖:

write 在类中 java.io.Writer

参数:

c - An integer specifying the character to write.

抛出:

java.io.IOException - If an IO error occurs.

write

public void write(java.lang.String str,
         int off,
         int len)
           throws java.io.IOException

Writes a portion of a string.

覆盖:

write 在类中 java.io.Writer

参数:

str - The string from which to write.

off - The offset from which to start writing characters.

len - The number of characters to write.

抛出:

java.io.IOException - If an IO error occurs.