Package org.apache.maven.shared.utils
Class WriterFactory
- java.lang.Object
-
- org.apache.maven.shared.utils.WriterFactory
-
public class WriterFactory extends java.lang.Object
Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.- Author:
- Hervé Boutemy
- See Also:
Charset
, Supported encodings
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FILE_ENCODING
Thefile.encoding
System Property.static java.lang.String
ISO_8859_1
Deprecated.usejava.nio.charset.StandardCharset.ISO_8859_1
static java.lang.String
US_ASCII
Deprecated.usejava.nio.charset.StandardCharset.US_ASCII
static java.lang.String
UTF_16
Deprecated.usejava.nio.charset.StandardCharset.UTF_16
static java.lang.String
UTF_16BE
Deprecated.usejava.nio.charset.StandardCharset.UTF_16BE
static java.lang.String
UTF_16LE
Deprecated.usejava.nio.charset.StandardCharset.UTF_16LE
static java.lang.String
UTF_8
Deprecated.usejava.nio.charset.StandardCharset.UTF_8
-
Constructor Summary
Constructors Constructor Description WriterFactory()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.io.Writer
newPlatformWriter(java.io.File file)
Deprecated.always specify an encoding.static java.io.Writer
newPlatformWriter(java.io.OutputStream out)
Deprecated.always specify an encoding.static java.io.Writer
newWriter(java.io.File file, java.lang.String encoding)
Create a new Writer with specified encoding.static java.io.Writer
newWriter(java.io.OutputStream out, java.lang.String encoding)
Create a new Writer with specified encoding.static XmlStreamWriter
newXmlWriter(java.io.File file)
Deprecated.use org.apache.commons.io.input.XmlStreamWriter insteadstatic XmlStreamWriter
newXmlWriter(java.io.OutputStream out)
Deprecated.use org.apache.commons.io.input.XmlStreamWriter instead
-
-
-
Field Detail
-
ISO_8859_1
@Deprecated public static final java.lang.String ISO_8859_1
Deprecated.usejava.nio.charset.StandardCharset.ISO_8859_1
ISO Latin Alphabet #1, also known as ISO-LATIN-1. Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
US_ASCII
@Deprecated public static final java.lang.String US_ASCII
Deprecated.usejava.nio.charset.StandardCharset.US_ASCII
Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set. Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
UTF_16
@Deprecated public static final java.lang.String UTF_16
Deprecated.usejava.nio.charset.StandardCharset.UTF_16
Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output). Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
UTF_16BE
@Deprecated public static final java.lang.String UTF_16BE
Deprecated.usejava.nio.charset.StandardCharset.UTF_16BE
Sixteen-bit Unicode Transformation Format, big-endian byte order. Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
UTF_16LE
@Deprecated public static final java.lang.String UTF_16LE
Deprecated.usejava.nio.charset.StandardCharset.UTF_16LE
Sixteen-bit Unicode Transformation Format, little-endian byte order. Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
UTF_8
@Deprecated public static final java.lang.String UTF_8
Deprecated.usejava.nio.charset.StandardCharset.UTF_8
Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding.- See Also:
- Constant Field Values
-
FILE_ENCODING
public static final java.lang.String FILE_ENCODING
Thefile.encoding
System Property.
-
-
Method Detail
-
newXmlWriter
@Deprecated public static XmlStreamWriter newXmlWriter(@Nonnull java.io.OutputStream out) throws java.io.IOException
Deprecated.use org.apache.commons.io.input.XmlStreamWriter insteadCreate a new Writer with XML encoding detection rules.- Parameters:
out
- not null output stream- Returns:
- an XML writer instance for the output stream
- Throws:
java.io.IOException
- if any- See Also:
XmlStreamWriter
-
newXmlWriter
@Deprecated public static XmlStreamWriter newXmlWriter(@Nonnull java.io.File file) throws java.io.IOException
Deprecated.use org.apache.commons.io.input.XmlStreamWriter insteadCreate a new Writer with XML encoding detection rules.- Parameters:
file
- not null file- Returns:
- an XML writer instance for the output file
- Throws:
java.io.IOException
- if any- See Also:
XmlStreamWriter
-
newPlatformWriter
@Deprecated public static java.io.Writer newPlatformWriter(@Nonnull java.io.OutputStream out)
Deprecated.always specify an encoding. Do not depend on the default platform character set.Create a new Writer with default platform encoding.- Parameters:
out
- not null output stream- Returns:
- a writer instance for the output stream using the default platform charset
-
newPlatformWriter
@Deprecated public static java.io.Writer newPlatformWriter(@Nonnull java.io.File file) throws java.io.IOException
Deprecated.always specify an encoding. Do not depend on the default platform character set.Create a new Writer with default platform encoding.- Parameters:
file
- not null file- Returns:
- a writer instance for the output file using the default platform charset
- Throws:
java.io.IOException
- if any
-
newWriter
public static java.io.Writer newWriter(@Nonnull java.io.OutputStream out, @Nonnull java.lang.String encoding) throws java.io.UnsupportedEncodingException
Create a new Writer with specified encoding.- Parameters:
out
- not null output streamencoding
- not null supported encoding- Returns:
- a writer instance for the output stream using the given encoding
- Throws:
java.io.UnsupportedEncodingException
- if any- See Also:
- Supported encodings
-
newWriter
public static java.io.Writer newWriter(@Nonnull java.io.File file, @Nonnull java.lang.String encoding) throws java.io.UnsupportedEncodingException, java.io.FileNotFoundException
Create a new Writer with specified encoding.- Parameters:
file
- not null fileencoding
- not null supported encoding- Returns:
- a writer instance for the output file using the given encoding
- Throws:
java.io.UnsupportedEncodingException
- if anyjava.io.FileNotFoundException
- if any- See Also:
- Supported encodings
-
-