org.teatrove.tea.io
Class EscapeReader

java.lang.Object
  java.io.Reader
      java.io.FilterReader
          org.teatrove.trove.io.PositionReader
              org.teatrove.tea.io.PositionReader
                  org.teatrove.tea.io.EscapeReader

All Implemented Interfaces:

Closeable, Readable

Direct Known Subclasses:

TagReader, UnicodeReader

Deprecated. Moved to org.teatrove.trove.io package.

public abstract class EscapeReader
extends PositionReader

This reader aids in decoding escapes in a character stream.

Author:

Brian S O'Neill

Field Summary

protected boolean	mEscapesEnabled Deprecated.
protected PushbackPositionReader	mSource Deprecated.

Fields inherited from class org.teatrove.trove.io.PositionReader

mPosition, mPosReader

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

EscapeReader(Reader source, int escapeSize)
Deprecated. An EscapeReader needs an underlying source reader.

Method Summary

int	getNextPosition() Deprecated.
Reader	getOriginalSource() Deprecated.
boolean	isEscapesEnabled() Deprecated. Escapes are enabled by default.
void	setEscapesEnabled(boolean enabled) Deprecated. Enable or disable the processing of escapes.

Methods inherited from class org.teatrove.trove.io.PositionReader

close, read, read

Methods inherited from class java.io.FilterReader

mark, markSupported, ready, reset, skip

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

Field Detail

mSource

protected PushbackPositionReader mSource

Deprecated.

mEscapesEnabled

protected boolean mEscapesEnabled

Deprecated.

Constructor Detail

EscapeReader

public EscapeReader(Reader source,
                    int escapeSize)

Deprecated.

An EscapeReader needs an underlying source reader.

Parameters:

source - the source Reader

escapeSize - the number of characters in an escape code

Method Detail

getOriginalSource

public Reader getOriginalSource()

Deprecated.

isEscapesEnabled

public boolean isEscapesEnabled()

Deprecated.

Escapes are enabled by default.

setEscapesEnabled

public void setEscapesEnabled(boolean enabled)

Deprecated.

Enable or disable the processing of escapes. When disabled, this Reader only functions as a PushbackReader.

getNextPosition

public int getNextPosition()

Deprecated.

Overrides:

getNextPosition in class PositionReader

Returns:

the position of the next character to be read.