org.apache.maven.shared.utils

Class ReaderFactory

java.lang.Object

org.apache.maven.shared.utils.ReaderFactory

public class ReaderFactory
extends Object

Utility to create Readers from streams, with explicit encoding choice: platform default, XML, or specified.

Author:

Hervé Boutemy

See Also:

Charset, Supported encodings

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_ENCODING The file.encoding System Property.
static String	ISO_8859_1 Deprecated. use java.nio.charset.StandardCharset.ISO_8859_1
static String	US_ASCII Deprecated. use java.nio.charset.StandardCharset.US_ASCII
static String	UTF_16 Deprecated. use java.nio.charset.StandardCharset.UTF_16
static String	UTF_16BE Deprecated. use java.nio.charset.StandardCharset.UTF_16BE
static String	UTF_16LE Deprecated. use java.nio.charset.StandardCharset.UTF_16LE
static String	UTF_8 Deprecated. use java.nio.charset.StandardCharset.UTF_8

Constructor Summary

Constructors

Constructor and Description
ReaderFactory()

Method Summary

Modifier and Type	Method and Description
static Reader	newPlatformReader(File file) Deprecated. always specify an encoding. Do not depend on the default platform character set.
static Reader	newReader(File file, String encoding) Create a new Reader with specified encoding.
static Reader	newReader(InputStream in, String encoding) Create a new Reader with specified encoding.
static Reader	newReader(URL url, String encoding) Create a new Reader with specified encoding.
static Reader	newXmlReader(File file) Deprecated. use org.apache.commons.io.input.XmlStreamReader instead
static Reader	newXmlReader(InputStream in) Deprecated. use org.apache.commons.io.input.XmlStreamReader instead
static Reader	newXmlReader(URL url) Deprecated. use org.apache.commons.io.input.XmlStreamReader instead

Methods inherited from class java.lang.Object

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

Field Detail

ISO_8859_1

@Deprecated
public static final String ISO_8859_1

Deprecated. use java.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 String US_ASCII

Deprecated. use java.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 String UTF_16

Deprecated. use java.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 String UTF_16BE

Deprecated. use java.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 String UTF_16LE

Deprecated. use java.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 String UTF_8

Deprecated. use java.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 String FILE_ENCODING

The file.encoding System Property.

Constructor Detail

ReaderFactory

public ReaderFactory()

Method Detail

newXmlReader

@Deprecated
public static Reader newXmlReader(@Nonnull
                                              InputStream in)
                                       throws IOException

Deprecated. use org.apache.commons.io.input.XmlStreamReader instead

Create a new Reader with XML encoding detection rules.

Parameters:

in - not null input stream

Returns:

an XML reader instance for the input stream

Throws:

IOException - if any

newXmlReader

@Deprecated
public static Reader newXmlReader(@Nonnull
                                              File file)
                                       throws IOException

Deprecated. use org.apache.commons.io.input.XmlStreamReader instead

Create a new Reader with XML encoding detection rules.

Parameters:

file - not null file

Returns:

an XML reader instance for the input file

Throws:

IOException - if any

newXmlReader

@Deprecated
public static Reader newXmlReader(@Nonnull
                                              URL url)
                                       throws IOException

Deprecated. use org.apache.commons.io.input.XmlStreamReader instead

Create a new Reader with XML encoding detection rules.

Parameters:

url - not null URL

Returns:

an XML reader instance for the input URL

Throws:

IOException - if any

newPlatformReader

@Deprecated
public static Reader newPlatformReader(@Nonnull
                                                   File file)
                                            throws FileNotFoundException

Deprecated. always specify an encoding. Do not depend on the default platform character set.

Create a new Reader with default platform encoding.

Parameters:

file - not null file.

Returns:

a reader instance for the input file using the default platform character set

Throws:

FileNotFoundException - if any

See Also:

Charset.defaultCharset()

newReader

public static Reader newReader(@Nonnull
                               InputStream in,
                               @Nonnull
                               String encoding)
                        throws UnsupportedEncodingException

Create a new Reader with specified encoding.

Parameters:

in - not null input stream

encoding - not null supported encoding

Returns:

a reader instance for the input stream using the given encoding

Throws:

UnsupportedEncodingException - if any

See Also:

Supported encodings

newReader

public static Reader newReader(@Nonnull
                               File file,
                               @Nonnull
                               String encoding)
                        throws FileNotFoundException,
                               UnsupportedEncodingException

Create a new Reader with specified encoding.

Parameters:

file - not null file

encoding - not null supported encoding

Returns:

a reader instance for the input file using the given encoding

Throws:

FileNotFoundException - if any

UnsupportedEncodingException - if any

See Also:

Supported encodings

newReader

public static Reader newReader(@Nonnull
                               URL url,
                               @Nonnull
                               String encoding)
                        throws IOException

Create a new Reader with specified encoding.

Parameters:

url - not null URL

encoding - not null supported encoding

Returns:

a reader instance for the input URL using the given encoding

Throws:

IOException - if any

See Also:

Supported encodings