org.codehaus.plexus.util

Class WriterFactory


public class WriterFactory
extends java.lang.Object

Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.
Version:
$Id: WriterFactory.java 6697 2007-07-28 12:25:52Z hboutemy $
Author:
Herve Boutemy
Since:
1.4.4
See Also:
Charset, Supported encodings

Field Summary

static String
FILE_ENCODING
The file.encoding System Property.
static String
ISO_8859_1
ISO Latin Alphabet #1, also known as ISO-LATIN-1.
static String
US_ASCII
Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
static String
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).
static String
UTF_16BE
Sixteen-bit Unicode Transformation Format, big-endian byte order.
static String
UTF_16LE
Sixteen-bit Unicode Transformation Format, little-endian byte order.
static String
UTF_8
Eight-bit Unicode Transformation Format.

Method Summary

static Writer
newPlatformWriter(File file)
Create a new Writer with default plaform encoding.
static Writer
newPlatformWriter(OutputStream out)
Create a new Writer with default plaform encoding.
static Writer
newWriter(File file, String encoding)
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

FILE_ENCODING

public static final String FILE_ENCODING
The file.encoding System Property.

ISO_8859_1

public static final String 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:
Charset

US_ASCII

public static final String 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:
Charset

UTF_16

public static final String 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:
Charset

UTF_16BE

public static final String 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:
Charset

UTF_16LE

public static final String 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:
Charset

UTF_8

public static final String UTF_8
Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding.
See Also:
Charset

Method Details

newPlatformWriter

public static Writer newPlatformWriter(File file)
            throws IOException
Create a new Writer with default plaform encoding.

newPlatformWriter

public static Writer newPlatformWriter(OutputStream out)
Create a new Writer with default plaform encoding.

newWriter

public static Writer newWriter(File file,
                               String encoding)
            throws UnsupportedEncodingException,
                   FileNotFoundException
Create a new Writer with specified encoding.

newWriter

public static Writer newWriter(OutputStream out,
                               String encoding)
            throws UnsupportedEncodingException
Create a new Writer with specified encoding.

newXmlWriter

public static XmlStreamWriter newXmlWriter(File file)
            throws IOException
Create a new Writer with XML encoding detection rules.

newXmlWriter

public static XmlStreamWriter newXmlWriter(OutputStream out)
            throws IOException
Create a new Writer with XML encoding detection rules.