net.sf.okapi.common

Class UnicodeBOMWriter

java.lang.Object

java.io.Writer

net.sf.okapi.common.UnicodeBOMWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class UnicodeBOMWriter
extends Writer

An UnicodeBOMWriter is a thin wrapper around OutputStreamWriter, except that it adds a BOM (Byte Order Mark) at the beginning;

For documentation on the behavior in case of invalid Unicode sequences (malformed surrogates, etc.) see the doc for OutputStreamWriter

See Also:

Charset, OutputStream, OutputStreamWriter

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
UnicodeBOMWriter(File file, String charsetName) Creates an UnicodeBOMWriter that uses the named charset.
UnicodeBOMWriter(String fileName, String charsetName) Creates an UnicodeBOMWriter that uses the named charset.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

UnicodeBOMWriter

public UnicodeBOMWriter(File file,
                        String charsetName)
                 throws IOException

Creates an UnicodeBOMWriter that uses the named charset.

Parameters:

file - The output File to write to

charsetName - The name of a supported Charset

Throws:

IOException - If the encoding is not supported or any problems writing to the stream

UnicodeBOMWriter

public UnicodeBOMWriter(String fileName,
                        String charsetName)
                 throws IOException

Creates an UnicodeBOMWriter that uses the named charset.

Parameters:

fileName - The name of the output file

charsetName - The name of a supported Charset

Throws:

IOException - If the encoding is not supported or any problems writing to the stream

Method Detail

write

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

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException