Package org.eclipse.text.readers

Class SubstitutionReader

java.lang.Object

java.io.Reader

org.eclipse.text.readers.SingleCharacterReader

org.eclipse.text.readers.SubstitutionReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public abstract class SubstitutionReader
extends SingleCharacterReader

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.

Moved into this package from org.eclipse.jface.internal.text.revisions.

Since:

3.14

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	fWasWhiteSpace
protected static final String	LINE_DELIM

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubstitutionReader(Reader reader)

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract String	computeSubstitution(int c)	Computes the substitution for the given character and if necessary subsequent characters.
protected Reader	getReader()	Returns the internal reader.
protected final boolean	isSkippingWhitespace()
protected int	nextChar()	Returns the next character.
int	read()
boolean	ready()
void	reset()
protected final void	setSkipWhitespace(boolean state)

Methods inherited from class org.eclipse.text.readers.SingleCharacterReader

getString, read

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, skip, transferTo

Methods inherited from class java.lang.Object

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

Field Details

LINE_DELIM

protected static final String LINE_DELIM

fWasWhiteSpace

protected boolean fWasWhiteSpace

Constructor Details

SubstitutionReader

protected SubstitutionReader(Reader reader)

Method Details

computeSubstitution

protected abstract String computeSubstitution(int c)
                                       throws IOException

Computes the substitution for the given character and if necessary subsequent characters. Implementation should use nextChar to read subsequent characters.

Parameters:

c - the character to be substituted

Returns:

the substitution for c

Throws:

IOException - in case computing the substitution fails

getReader

protected Reader getReader()

Returns the internal reader.

Returns:

the internal reader

nextChar

protected int nextChar()
                throws IOException

Returns the next character.

Returns:

the next character

Throws:

IOException - in case reading the character fails

read

public int read()
         throws IOException

Specified by:

read in class SingleCharacterReader

Throws:

IOException

See Also:

• Reader.read()

ready

public boolean ready()
              throws IOException

Overrides:

ready in class SingleCharacterReader

Throws:

IOException

See Also:

• Reader.ready()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

See Also:

• Reader.close()

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

See Also:

• Reader.reset()

setSkipWhitespace

protected final void setSkipWhitespace(boolean state)

isSkippingWhitespace

protected final boolean isSkippingWhitespace()