001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
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.colorizer;
021    
022    /**
023     * IMPORTANT: Tokenizers must be THREAD-SAFE.
024     */
025    public abstract class Tokenizer {
026    
027      protected final String tagBefore;
028      protected final String tagAfter;
029    
030      public Tokenizer(String tagBefore, String tagAfter) {
031        this.tagBefore = tagBefore;
032        this.tagAfter = tagAfter;
033      }
034    
035      public abstract boolean hasNextToken(CodeReader code);
036    
037      public abstract String nextToken(CodeReader code);
038    
039      public String getTagBefore() {
040        return tagBefore;
041      }
042    
043      public String getTagAfter() {
044        return tagAfter;
045      }
046    
047      public String getTagBeginOfFile() {
048        return "";
049      }
050    
051      public String getTagEndOfFile() {
052        return "";
053      }
054    }