ReaderFactory (Apache Maven Shared Utils 0.6 API)

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` 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.

Constructor Summary

Constructors
Constructor and Description

ReaderFactory()

Constructors
Constructor and Description
`ReaderFactory()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Reader`	`newPlatformReader(File file)` 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 Reader`	`newXmlReader(File file)` Create a new Reader with XML encoding detection rules.
`static Reader`	`newXmlReader(InputStream in)` Create a new Reader with XML encoding detection rules.
`static Reader`	`newXmlReader(URL url)` Create a new Reader with XML encoding detection rules.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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, Constant Field Values
  - 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, Constant Field Values
  - 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, Constant Field Values
  - 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, Constant Field Values
  - 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, Constant Field Values
  - 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, Constant Field Values
  - FILE_ENCODING
```
public static final String FILE_ENCODING
```
    The file.encoding System Property.
- Constructor Detail
  - ReaderFactory
```
public ReaderFactory()
```
- Method Detail
  - newXmlReader
```
public static Reader newXmlReader(@Nonnull
                  InputStream in)
                           throws IOException
```
    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 Reader newXmlReader(@Nonnull
                  File file)
                           throws IOException
```
    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 Reader newXmlReader(@Nonnull
                  URL url)
                           throws IOException
```
    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
  - newPlatformReader
```
public static Reader newPlatformReader(@Nonnull
                       File file)
                                throws FileNotFoundException
```
    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()
  - 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

Class ReaderFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ISO_8859_1

US_ASCII

UTF_16

UTF_16BE

UTF_16LE

UTF_8

FILE_ENCODING

Constructor Detail

ReaderFactory

Method Detail

newXmlReader

newXmlReader

newXmlReader

newPlatformReader

newReader

newReader

newReader