View Javadoc

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