Skip navigation links


com.essbase.eas.utils
Class TextFileReader

java.lang.Object
  extended by java.io.Reader
      extended by com.essbase.eas.utils.TextFileReader

All Implemented Interfaces:
java.io.Closeable, java.lang.Readable

public class TextFileReader
extends java.io.Reader

Field Summary

 

Fields inherited from class java.io.Reader
lock

 

Constructor Summary
TextFileReader(java.io.File file)
           
TextFileReader(java.io.File file, java.io.Reader in)
          Create a buffering character-input stream that uses a default-sized input buffer.
TextFileReader(java.io.File file, java.io.Reader in, int sz)
          Create a buffering character-input stream that uses an input buffer of the specified size.

 

Method Summary
 void close()
          Close the stream.
 long getBytesRead()
           
 java.lang.String getCharacterSet()
           
 short getEncoding()
           
 char getEOLChar()
           
 java.io.File getFile()
           
 short getPercentRead()
           
 boolean isUTF8()
           
 void mark(int readAheadLimit)
          Mark the present position in the stream.
 boolean markSupported()
          Tell whether this stream supports the mark() operation, which it does.
 int read()
          Read a single character.
 int read(char[] cbuf, int off, int len)
          Read characters into a portion of an array.
 java.lang.String readLine()
          Read a line of text.
 boolean ready()
          Tell whether this stream is ready to be read.
 void reset()
          Reset the stream to the most recent mark.
 void setCharacterSet(java.lang.String charset)
           
 void setCloseOnDelete()
           
 void setEncoding(short encoding)
           
 void setEOLChar(char eolChar)
           
 void setTotalBytes(long len)
           
 long skip(long n)
          Skip characters.

 

Methods inherited from class java.io.Reader
read, read

 

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

 

Constructor Detail

TextFileReader

public TextFileReader(java.io.File file,
                      java.io.Reader in,
                      int sz)
Create a buffering character-input stream that uses an input buffer of the specified size.
Parameters:
in - A Reader
sz - Input-buffer size
Throws:
java.lang.IllegalArgumentException - If sz is <= 0

TextFileReader

public TextFileReader(java.io.File file,
                      java.io.Reader in)
Create a buffering character-input stream that uses a default-sized input buffer.
Parameters:
in - A Reader

TextFileReader

public TextFileReader(java.io.File file)
               throws java.io.IOException
Throws:
java.io.IOException

Method Detail

getEncoding

public short getEncoding()

setEncoding

public void setEncoding(short encoding)

setCharacterSet

public void setCharacterSet(java.lang.String charset)

getCharacterSet

public java.lang.String getCharacterSet()

isUTF8

public boolean isUTF8()

read

public int read()
         throws java.io.IOException
Read a single character.
Overrides:
read in class java.io.Reader
Returns:
The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached
Throws:
java.io.IOException - If an I/O error occurs

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException
Read characters into a portion of an array.

This method implements the general contract of the corresponding read method of the Reader class. As an additional convenience, it attempts to read as many characters as possible by repeatedly invoking the read method of the underlying stream. This iterated read continues until one of the following conditions becomes true:

If the first read on the underlying stream returns -1 to indicate end-of-file then this method returns -1. Otherwise this method returns the number of characters actually read.

Subclasses of this class are encouraged, but not required, to attempt to read as many characters as possible in the same fashion.

Ordinarily this method takes characters from this stream's character buffer, filling it from the underlying stream as necessary. If, however, the buffer is empty, the mark is not valid, and the requested length is at least as large as the buffer, then this method will read characters directly from the underlying stream into the given array. Thus redundant BufferedReaders will not copy data unnecessarily.

Specified by:
read in class java.io.Reader
Parameters:
cbuf - Destination buffer
off - Offset at which to start storing characters
len - Maximum number of characters to read
Returns:
The number of characters read, or -1 if the end of the stream has been reached
Throws:
java.io.IOException - If an I/O error occurs

readLine

public java.lang.String readLine()
                          throws java.io.IOException
Read a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
Returns:
A String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached
Throws:
java.io.IOException - If an I/O error occurs

skip

public long skip(long n)
          throws java.io.IOException
Skip characters.
Overrides:
skip in class java.io.Reader
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
java.lang.IllegalArgumentException - If n is negative.
java.io.IOException - If an I/O error occurs

ready

public boolean ready()
              throws java.io.IOException
Tell whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.
Overrides:
ready in class java.io.Reader
Throws:
java.io.IOException - If an I/O error occurs

markSupported

public boolean markSupported()
Tell whether this stream supports the mark() operation, which it does.
Overrides:
markSupported in class java.io.Reader

mark

public void mark(int readAheadLimit)
          throws java.io.IOException
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
Overrides:
mark in class java.io.Reader
Parameters:
readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care.
Throws:
java.lang.IllegalArgumentException - If readAheadLimit is < 0
java.io.IOException - If an I/O error occurs

reset

public void reset()
           throws java.io.IOException
Reset the stream to the most recent mark.
Overrides:
reset in class java.io.Reader
Throws:
java.io.IOException - If the stream has never been marked, or if the mark has been invalidated

close

public void close()
           throws java.io.IOException
Close the stream.
Specified by:
close in interface java.io.Closeable
Specified by:
close in class java.io.Reader
Throws:
java.io.IOException - If an I/O error occurs

setCloseOnDelete

public void setCloseOnDelete()

getBytesRead

public long getBytesRead()

getPercentRead

public short getPercentRead()

setEOLChar

public void setEOLChar(char eolChar)

getEOLChar

public char getEOLChar()

setTotalBytes

public void setTotalBytes(long len)

getFile

public java.io.File getFile()

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.