001: /* ====================================================================
002: * Tea - Copyright (c) 1997-2000 Walt Disney Internet Group
003: * ====================================================================
004: * The Tea Software License, Version 1.1
005: *
006: * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Walt Disney Internet Group (http://opensource.go.com/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact opensource@dig.com.
031: *
032: * 5. Products derived from this software may not be called "Tea",
033: * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
034: * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
035: * written permission of the Walt Disney Internet Group.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
041: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
042: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
043: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
044: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
045: * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
046: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
047: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
048: * ====================================================================
049: *
050: * For more information about Tea, please see http://opensource.go.com/.
051: */
052:
053: package com.go.tea.io;
054:
055: import java.io.*;
056:
057: /******************************************************************************
058: * This reader aids in decoding escapes in a character stream.
059: *
060: * @author Brian S O'Neill
061: * @version
062: * <!--$$Revision:--> 11 <!-- $-->, <!--$$JustDate:--> 12/11/00 <!-- $-->
063: * @deprecated Moved to com.go.trove.io package.
064: */
065: public abstract class EscapeReader extends PositionReader {
066: protected PushbackPositionReader mSource;
067: protected boolean mEscapesEnabled = true;
068:
069: private Reader mOriginal;
070:
071: /**
072: * An EscapeReader needs an underlying source reader.
073: *
074: * @param source the source Reader
075: * @param escapeSize the number of characters in an escape code
076: */
077: public EscapeReader(Reader source, int escapeSize) {
078: super (new PushbackPositionReader(source, escapeSize));
079: mSource = (PushbackPositionReader) in;
080: mOriginal = source;
081: }
082:
083: public Reader getOriginalSource() {
084: return mOriginal;
085: }
086:
087: /**
088: * Escapes are enabled by default.
089: */
090: public boolean isEscapesEnabled() {
091: return mEscapesEnabled;
092: }
093:
094: /**
095: * Enable or disable the processing of escapes. When disabled, this
096: * Reader only functions as a PushbackReader.
097: */
098: public void setEscapesEnabled(boolean enabled) {
099: mEscapesEnabled = enabled;
100: }
101:
102: /**
103: * @return the position of the next character to be read.
104: */
105: public int getNextPosition() {
106: return mSource.getNextPosition();
107: }
108: }
|