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     */
020    package org.sonar.duplications.statement.matcher;
021    
022    import java.util.HashSet;
023    import java.util.List;
024    import java.util.Set;
025    
026    import org.sonar.duplications.token.Token;
027    import org.sonar.duplications.token.TokenQueue;
028    
029    /**
030     * Consumes everything up to one of the specified tokens.
031     */
032    public class UptoTokenMatcher extends TokenMatcher {
033    
034      private final Set<String> uptoMatchTokens = new HashSet<String>();
035    
036      public UptoTokenMatcher(String[] uptoMatchTokens) {
037        if (uptoMatchTokens == null) {
038          throw new IllegalArgumentException();
039        }
040        if (uptoMatchTokens.length == 0) {
041          // otherwise we will always try to consume everything, but will never succeed
042          throw new IllegalArgumentException();
043        }
044        for (String uptoMatchToken : uptoMatchTokens) {
045          this.uptoMatchTokens.add(uptoMatchToken);
046        }
047      }
048    
049      @Override
050      public boolean matchToken(TokenQueue tokenQueue, List<Token> matchedTokenList) {
051        do {
052          Token token = tokenQueue.poll();
053          matchedTokenList.add(token);
054          if (uptoMatchTokens.contains(token.getValue())) {
055            return true;
056          }
057        } while (tokenQueue.peek() != null);
058        return false;
059      }
060    
061    }