Package org.codehaus.plexus.util

Class WriterFactory

java.lang.Object

org.codehaus.plexus.util.WriterFactory

@Deprecated
public class WriterFactory
extends Object

Deprecated.

This class has been deprecated. When writing XML, users can create the XmlStreamWriter instance directly. For other usages, using Files helper methods is recommended.

Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.

Since:

1.4.4

Author:

Herve Boutemy

See Also:

• Charset
• Supported encodings

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WriterFactory()	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Writer	newPlatformWriter(File file)	Deprecated. Create a new Writer with default platform encoding.
static Writer	newPlatformWriter(OutputStream out)	Deprecated. Create a new Writer with default platform encoding.
static Writer	newWriter(File file, String encoding)	Deprecated. Create a new Writer with specified encoding.
static Writer	newWriter(OutputStream out, String encoding)	Deprecated. Create a new Writer with specified encoding.
static org.codehaus.plexus.util.xml.XmlStreamWriter	newXmlWriter(File file)	Deprecated. Create a new Writer with XML encoding detection rules.
static org.codehaus.plexus.util.xml.XmlStreamWriter	newXmlWriter(OutputStream out)	Deprecated. Create a new Writer with XML encoding detection rules.

Methods inherited from class java.lang.Object

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

Field Details

ISO_8859_1

public static final String ISO_8859_1

Deprecated.

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
• Constant Field Values

US_ASCII

public static final String US_ASCII

Deprecated.

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
• Constant Field Values

UTF_16

public static final String UTF_16

Deprecated.

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
• Constant Field Values

UTF_16BE

public static final String UTF_16BE

Deprecated.

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
• Constant Field Values

UTF_16LE

public static final String UTF_16LE

Deprecated.

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
• Constant Field Values

UTF_8

public static final String UTF_8

Deprecated.

Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding.

See Also:

• Charset
• Constant Field Values

FILE_ENCODING

public static final String FILE_ENCODING

Deprecated.

The file.encoding System Property.

Constructor Details

WriterFactory

public WriterFactory()

Deprecated.

Method Details

newXmlWriter

public static org.codehaus.plexus.util.xml.XmlStreamWriter newXmlWriter(OutputStream out)
                                                                 throws IOException

Deprecated.

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:

• XmlStreamWriter

newXmlWriter

public static org.codehaus.plexus.util.xml.XmlStreamWriter newXmlWriter(File file)
                                                                 throws IOException

Deprecated.

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:

• XmlStreamWriter

newPlatformWriter

public static Writer newPlatformWriter(OutputStream out)

Deprecated.

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:

• Charset.defaultCharset()

newPlatformWriter

public static Writer newPlatformWriter(File file)
                                throws IOException

Deprecated.

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:

• Charset.defaultCharset()

newWriter

public static Writer newWriter(OutputStream out,
 String encoding)
                        throws UnsupportedEncodingException

Deprecated.

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:

• Supported encodings

newWriter

public static Writer newWriter(File file,
 String encoding)
                        throws IOException

Deprecated.

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:

• Supported encodings