Package org.codehaus.plexus.util
Class WriterFactory
java.lang.Object
org.codehaus.plexus.util.WriterFactory
Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.
- Since:
- 1.4.4
- Author:
- Herve Boutemy
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Thefile.encoding
System Property.static final String
ISO Latin Alphabet #1, also known as ISO-LATIN-1.static final String
Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.static final String
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).static final String
Sixteen-bit Unicode Transformation Format, big-endian byte order.static final String
Sixteen-bit Unicode Transformation Format, little-endian byte order.static final String
Eight-bit Unicode Transformation Format. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Writer
newPlatformWriter
(File file) Create a new Writer with default platform encoding.static Writer
Create a new Writer with default platform encoding.static Writer
Create a new Writer with specified encoding.static Writer
newWriter
(OutputStream out, String encoding) Create a new Writer with specified encoding.static XmlStreamWriter
newXmlWriter
(File file) Create a new Writer with XML encoding detection rules.static XmlStreamWriter
newXmlWriter
(OutputStream out) Create a new Writer with XML encoding detection rules.
-
Field Details
-
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:
-
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:
-
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:
-
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:
-
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:
-
UTF_8
Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding.- See Also:
-
FILE_ENCODING
Thefile.encoding
System Property.
-
-
Constructor Details
-
WriterFactory
public WriterFactory()
-
-
Method Details
-
newXmlWriter
Create a new Writer with XML encoding detection rules.- Parameters:
out
- not null output stream.- Returns:
- an XML writer instance for the output stream.
- Throws:
IOException
- if any.- See Also:
-
newXmlWriter
Create a new Writer with XML encoding detection rules.- Parameters:
file
- not null file.- Returns:
- an XML writer instance for the output file.
- Throws:
IOException
- if any.- See Also:
-
newPlatformWriter
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.
- See Also:
-
newPlatformWriter
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:
IOException
- if any.- See Also:
-
newWriter
public static Writer newWriter(OutputStream out, String encoding) throws UnsupportedEncodingException Create a new Writer with specified encoding.- Parameters:
out
- not null output stream.encoding
- not null supported encoding.- Returns:
- a writer instance for the output stream using the given encoding.
- Throws:
UnsupportedEncodingException
- if any.- See Also:
-
newWriter
Create a new Writer with specified encoding.- Parameters:
file
- not null file.encoding
- not null supported encoding.- Returns:
- a writer instance for the output file using the given encoding.
- Throws:
IOException
- if any.- See Also:
-