001/*-------------------------------------------------------------------------+
002|                                                                          |
003| Copyright 2005-2011 the ConQAT Project                                   |
004|                                                                          |
005| Licensed under the Apache License, Version 2.0 (the "License");          |
006| you may not use this file except in compliance with the License.         |
007| You may obtain a copy of the License at                                  |
008|                                                                          |
009|    http://www.apache.org/licenses/LICENSE-2.0                            |
010|                                                                          |
011| Unless required by applicable law or agreed to in writing, software      |
012| distributed under the License is distributed on an "AS IS" BASIS,        |
013| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
014| See the License for the specific language governing permissions and      |
015| limitations under the License.                                           |
016+-------------------------------------------------------------------------*/
017package eu.cqse.check.framework.util.tokens;
018
019import eu.cqse.check.framework.scanner.IToken;
020
021/**
022 * Base class for patterns that look only at the current token in the stream and
023 * advance the stream by 1 if they matched.
024 */
025public abstract class SingleTokenPatternBase extends TokenPatternBase {
026
027        /** {@inheritDoc} */
028        @Override
029        protected TokenPatternMatch matchesLocally(TokenStream stream) {
030                IToken token = stream.next();
031                if (token == null || !matchesToken(token)) {
032                        return null;
033                }
034                return createMatch(stream);
035        }
036
037        /** Returns <code>true</code> if the pattern matches the given token. */
038        public abstract boolean matchesToken(IToken token);
039}