Package org.apache.commons.io.output
Class FileWriterWithEncoding
- java.lang.Object
-
- java.io.Writer
-
- java.io.FilterWriter
-
- org.apache.commons.io.output.ProxyWriter
-
- org.apache.commons.io.output.FileWriterWithEncoding
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
public class FileWriterWithEncoding extends ProxyWriter
Writer of files that allows the encoding to be set.This class provides a simple alternative to
FileWriter
that allows an encoding to be set. Unfortunately, it cannot subclassFileWriter
.By default, the file will be overwritten, but this may be changed to append.
The encoding must be specified using either the name of the
Charset
, theCharset
, or aCharsetEncoder
. If the default encoding is required then use theFileWriter
directly, rather than this implementation.To build an instance, see
FileWriterWithEncoding.Builder
.- Since:
- 1.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileWriterWithEncoding.Builder
Builds a newFileWriterWithEncoding
instance.
-
Constructor Summary
Constructors Constructor Description FileWriterWithEncoding(java.io.File file, java.lang.String charsetName)
Deprecated.FileWriterWithEncoding(java.io.File file, java.lang.String charsetName, boolean append)
Deprecated.FileWriterWithEncoding(java.io.File file, java.nio.charset.Charset charset)
Deprecated.FileWriterWithEncoding(java.io.File file, java.nio.charset.CharsetEncoder charsetEncoder)
Deprecated.FileWriterWithEncoding(java.io.File file, java.nio.charset.CharsetEncoder charsetEncoder, boolean append)
Deprecated.FileWriterWithEncoding(java.io.File file, java.nio.charset.Charset encoding, boolean append)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.lang.String charsetName)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.lang.String charsetName, boolean append)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.Charset charset)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.CharsetEncoder encoding)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.CharsetEncoder charsetEncoder, boolean append)
Deprecated.FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.Charset charset, boolean append)
Deprecated.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FileWriterWithEncoding.Builder
builder()
Constructs a newFileWriterWithEncoding.Builder
.
-
-
-
Constructor Detail
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.nio.charset.Charset charset) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not nullcharset
- the encoding to use, not null- Throws:
java.lang.NullPointerException
- if the file or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.nio.charset.Charset encoding, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not null.encoding
- the name of the requested charset, null uses the default Charset.append
- true if content should be appended, false to overwrite.- Throws:
java.lang.NullPointerException
- if the file is null.java.io.IOException
- in case of an I/O error.
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.nio.charset.CharsetEncoder charsetEncoder) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not nullcharsetEncoder
- the encoding to use, not null- Throws:
java.lang.NullPointerException
- if the file or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.nio.charset.CharsetEncoder charsetEncoder, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not null.charsetEncoder
- the encoding to use, null uses the default Charset.append
- true if content should be appended, false to overwrite.- Throws:
java.lang.NullPointerException
- if the file is null.java.io.IOException
- in case of an I/O error.
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.lang.String charsetName) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not nullcharsetName
- the name of the requested charset, not null- Throws:
java.lang.NullPointerException
- if the file or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.io.File file, java.lang.String charsetName, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
file
- the file to write to, not null.charsetName
- the name of the requested charset, null uses the default Charset.append
- true if content should be appended, false to overwrite.- Throws:
java.lang.NullPointerException
- if the file is null.java.io.IOException
- in case of an I/O error.
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.Charset charset) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullcharset
- the charset to use, not null- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.Charset charset, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullcharset
- the encoding to use, not nullappend
- true if content should be appended, false to overwrite- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.CharsetEncoder encoding) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullencoding
- the encoding to use, not null- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.nio.charset.CharsetEncoder charsetEncoder, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullcharsetEncoder
- the encoding to use, not nullappend
- true if content should be appended, false to overwrite- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.lang.String charsetName) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullcharsetName
- the name of the requested charset, not null- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
FileWriterWithEncoding
@Deprecated public FileWriterWithEncoding(java.lang.String fileName, java.lang.String charsetName, boolean append) throws java.io.IOException
Deprecated.Constructs a FileWriterWithEncoding with a file encoding.- Parameters:
fileName
- the name of the file to write to, not nullcharsetName
- the name of the requested charset, not nullappend
- true if content should be appended, false to overwrite- Throws:
java.lang.NullPointerException
- if the file name or encoding is nulljava.io.IOException
- in case of an I/O error
-
-
Method Detail
-
builder
public static FileWriterWithEncoding.Builder builder()
Constructs a newFileWriterWithEncoding.Builder
.- Returns:
- Creates a new
FileWriterWithEncoding.Builder
. - Since:
- 2.12.0
-
-