org.codehaus.plexus.util

Class ReaderFactory


public class ReaderFactory
extends java.lang.Object

Utility to create Readers from streams, with explicit encoding choice: platform default, XML, or specified.
Version:
$Id: ReaderFactory.java 6704 2007-07-28 23:03:53Z jvanzyl $
Author:
Herve Boutemy
Since:
1.4.3
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 Reader
newPlatformReader(File file)
Create a new Reader with default plaform encoding.
static Reader
newPlatformReader(InputStream in)
Create a new Reader with default plaform encoding.
static Reader
newPlatformReader(URL url)
Create a new Reader with default plaform encoding.
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 XmlStreamReader
newXmlReader(File file)
Create a new Reader with XML encoding detection rules.
static XmlStreamReader
newXmlReader(InputStream in)
Create a new Reader with XML encoding detection rules.
static XmlStreamReader
newXmlReader(URL url)
Create a new Reader 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

newPlatformReader

public static Reader newPlatformReader(File file)
            throws FileNotFoundException
Create a new Reader with default plaform encoding.

newPlatformReader

public static Reader newPlatformReader(InputStream in)
Create a new Reader with default plaform encoding.

newPlatformReader

public static Reader newPlatformReader(URL url)
            throws IOException
Create a new Reader with default plaform encoding.

newReader

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

newReader

public static Reader newReader(InputStream in,
                               String encoding)
            throws UnsupportedEncodingException
Create a new Reader with specified encoding.

newReader

public static Reader newReader(URL url,
                               String encoding)
            throws IOException
Create a new Reader with specified encoding.

newXmlReader

public static XmlStreamReader newXmlReader(File file)
            throws IOException
Create a new Reader with XML encoding detection rules.

newXmlReader

public static XmlStreamReader newXmlReader(InputStream in)
            throws IOException
Create a new Reader with XML encoding detection rules.

newXmlReader

public static XmlStreamReader newXmlReader(URL url)
            throws IOException
Create a new Reader with XML encoding detection rules.