org.codehaus.plexus.util

Class ReaderFactory

public class ReaderFactory extends Object

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

Since: 1.4.3

Version: $Id: ReaderFactory.java 8010 2009-01-07 12:59:50Z vsiveton $

Author: Herve Boutemy

See Also: Charset Supported encodings

Field Summary
static StringFILE_ENCODING
The file.encoding System Property.
static StringISO_8859_1
ISO Latin Alphabet #1, also known as ISO-LATIN-1.
static StringUS_ASCII
Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
static StringUTF_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 StringUTF_16BE
Sixteen-bit Unicode Transformation Format, big-endian byte order.
static StringUTF_16LE
Sixteen-bit Unicode Transformation Format, little-endian byte order.
static StringUTF_8
Eight-bit Unicode Transformation Format.
Method Summary
static ReadernewPlatformReader(InputStream in)
Create a new Reader with default plaform encoding.
static ReadernewPlatformReader(File file)
Create a new Reader with default plaform encoding.
static ReadernewPlatformReader(URL url)
Create a new Reader with default plaform encoding.
static ReadernewReader(InputStream in, String encoding)
Create a new Reader with specified encoding.
static ReadernewReader(File file, String encoding)
Create a new Reader with specified encoding.
static ReadernewReader(URL url, String encoding)
Create a new Reader with specified encoding.
static XmlStreamReadernewXmlReader(InputStream in)
Create a new Reader with XML encoding detection rules.
static XmlStreamReadernewXmlReader(File file)
Create a new Reader with XML encoding detection rules.
static XmlStreamReadernewXmlReader(URL url)
Create a new Reader with XML encoding detection rules.

Field Detail

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 Detail

newPlatformReader

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

Parameters: in not null input stream.

Returns: a reader instance for the input stream using the default platform charset.

See Also: Charset#defaultCharset()

newPlatformReader

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

Parameters: file not null file.

Returns: a reader instance for the input file using the default platform charset.

Throws: FileNotFoundException if any.

See Also: Charset#defaultCharset()

newPlatformReader

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

Parameters: url not null url.

Returns: a reader instance for the input url using the default platform charset.

Throws: IOException if any.

See Also: Charset#defaultCharset()

newReader

public static Reader newReader(InputStream in, String encoding)
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(File file, String encoding)
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(URL url, String encoding)
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

newXmlReader

public static XmlStreamReader newXmlReader(InputStream in)
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.

See Also: XmlStreamReader

newXmlReader

public static XmlStreamReader newXmlReader(File file)
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.

See Also: XmlStreamReader

newXmlReader

public static XmlStreamReader newXmlReader(URL url)
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.

See Also: XmlStreamReader

Copyright © 2001-2010 Codehaus. All Rights Reserved.