Tools/Source/Cpptasks/net/sf/antcontrib/cpptasks/parser/AbstractParserState.java

   1 /*
   2  *
   3  * Copyright 2002-2004 The Ant-Contrib project
   4  *
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  */
  17 package net.sf.antcontrib.cpptasks.parser;
  18 /**
  19  * An base class for objects that represent the state of an AbstractParser.
  20  *
  21  * @author CurtArnold
  22  * @see AbstractParser
  23  */
  24 public abstract class AbstractParserState {
  25     private AbstractParser parser;
  26     protected AbstractParserState(AbstractParser parser) {
  27         if (parser == null) {
  28             throw new NullPointerException("parser");
  29         }
  30         this.parser = parser;
  31     }
  32     /**
  33      * Consume a character
  34      *
  35      * @return new state, may be null to ignore the rest of the line
  36      */
  37     public abstract AbstractParserState consume(char ch);
  38     protected AbstractParser getParser() {
  39         return parser;
  40     }
  41 }