org.eclipse.jdt.internal.formatter.comment
Class SubstitutionTextReader

java.lang.Object
  extended by java.io.Reader
      extended by org.eclipse.jdt.internal.formatter.comment.SubstitutionTextReader
All Implemented Interfaces:
java.io.Closeable, java.lang.Readable
Direct Known Subclasses:
HTMLEntity2JavaReader, Java2HTMLEntityReader

public abstract class SubstitutionTextReader
extends java.io.Reader

Reads the text contents from a reader and computes for each character a potential substitution. The substitution may eat more characters than only the one passed into the computation routine.


Method Summary
 void close()
           
 java.lang.String getString()
          Gets the content as a String
 int read()
           
 int read(char[] cbuf, int off, int len)
           
 boolean ready()
           
 void reset()
           
 
Methods inherited from class java.io.Reader
mark, markSupported, read, read, skip
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getString

public java.lang.String getString()
                           throws java.io.IOException
Gets the content as a String

Throws:
java.io.IOException

read

public int read()
         throws java.io.IOException
Overrides:
read in class java.io.Reader
Throws:
java.io.IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException
Specified by:
read in class java.io.Reader
Throws:
java.io.IOException

ready

public boolean ready()
              throws java.io.IOException
Overrides:
ready in class java.io.Reader
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Specified by:
close in interface java.io.Closeable
Specified by:
close in class java.io.Reader
Throws:
java.io.IOException

reset

public void reset()
           throws java.io.IOException
Overrides:
reset in class java.io.Reader
Throws:
java.io.IOException