001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.duplications.statement.matcher;
021
022import java.util.List;
023
024import org.sonar.duplications.token.Token;
025import org.sonar.duplications.token.TokenQueue;
026
027public abstract class TokenMatcher {
028
029  /**
030   * @param tokenQueue queue of tokens for consumption, which contains at least one element
031   * @param matchedTokenList list to populate by tokens, which were consumed
032   * @return true if tokens were consumed successfully
033   */
034  public abstract boolean matchToken(TokenQueue tokenQueue, List<Token> matchedTokenList);
035
036}