Initial import.

[mirror_edk2.git] / Tools / Source / Cpptasks / net / sf / antcontrib / cpptasks / parser / AbstractParserState.java

/*\r
 * \r
 * Copyright 2002-2004 The Ant-Contrib project\r
 *\r
 *  Licensed under the Apache License, Version 2.0 (the "License");\r
 *  you may not use this file except in compliance with the License.\r
 *  You may obtain a copy of the License at\r
 *\r
 *      http://www.apache.org/licenses/LICENSE-2.0\r
 *\r
 *  Unless required by applicable law or agreed to in writing, software\r
 *  distributed under the License is distributed on an "AS IS" BASIS,\r
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 *  See the License for the specific language governing permissions and\r
 *  limitations under the License.\r
 */\r
package net.sf.antcontrib.cpptasks.parser;\r
/**\r
 * An base class for objects that represent the state of an AbstractParser.\r
 * \r
 * @author CurtArnold\r
 * @see AbstractParser\r
 */\r
public abstract class AbstractParserState {\r
    private AbstractParser parser;\r
    protected AbstractParserState(AbstractParser parser) {\r
        if (parser == null) {\r
            throw new NullPointerException("parser");\r
        }\r
        this.parser = parser;\r
    }\r
    /**\r
     * Consume a character\r
     * \r
     * @return new state, may be null to ignore the rest of the line\r
     */\r
    public abstract AbstractParserState consume(char ch);\r
    protected AbstractParser getParser() {\r
        return parser;\r
    }\r
}\r