org.rvpf.base.util

Class UnicodeStreamReader

Object

Reader

UnicodeStreamReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

@ThreadSafe
public class UnicodeStreamReader
extends Reader

Unicode stream reader.

Supports UTF-8 with optional BOM and UTF-16(BE/LE).

Note: when the BOM is absent, the presence of a 0x00 byte in only one of the first two bytes is used to recognize UTF-16.

Field Summary

Fields inherited from class Reader

lock

Constructor Summary

Constructors

Constructor and Description
UnicodeStreamReader(File inputFile) Constructs an instance.
UnicodeStreamReader(InputStream stream) Constructs an instance.
UnicodeStreamReader(String inputPath) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getEncoding() Gets the name of the character set encoding detected.
int	read()
int	read(char[] buffer, int offset, int length)
boolean	ready()

Methods inherited from class Reader

mark, markSupported, read, read, reset, skip

Methods inherited from class Object

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

Constructor Detail

UnicodeStreamReader

public UnicodeStreamReader(@Nonnull
                           File inputFile)
                    throws FileNotFoundException

Constructs an instance.

Parameters:

inputFile - The input file.

Throws:

FileNotFoundException - When the file is not found.

UnicodeStreamReader

public UnicodeStreamReader(@Nonnull
                           InputStream stream)

Constructs an instance.

Parameters:

stream - The Unicode input stream.

UnicodeStreamReader

public UnicodeStreamReader(@Nonnull
                           String inputPath)
                    throws FileNotFoundException

Constructs an instance.

Parameters:

inputPath - The input path.

Throws:

FileNotFoundException - When the file is not found.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException

getEncoding

@Nonnull
 @CheckReturnValue
public String getEncoding()
                                                 throws IOException

Gets the name of the character set encoding detected.

Returns:

The name of the character set encoding detected.

Throws:

IOException - When an I/O error occurs.

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] buffer,
                int offset,
                int length)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException