001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.web;
021    
022    import java.util.List;
023    
024    import com.google.common.base.Objects;
025    import org.sonar.api.ServerExtension;
026    import org.sonar.colorizer.Tokenizer;
027    
028    /**
029     * Extend the library sonar-colorizer to support new languages. By default only Java sources are colorized in Sonar.
030     * 
031     * @since 1.12
032     */
033    public abstract class CodeColorizerFormat implements ServerExtension {
034    
035      private String languageKey;
036    
037      /**
038       * @param languageKey the unique sonar key. Not null.
039       */
040      protected CodeColorizerFormat(String languageKey) {
041        this.languageKey = languageKey;
042      }
043    
044      public final String getLanguageKey() {
045        return languageKey;
046      }
047    
048      /**
049       * sonar-colorizer tokenizers for HTML output.
050       * 
051       * @return a not null list (empty if no tokenizers)
052       */
053      public abstract List<Tokenizer> getTokenizers();
054    
055      @Override
056      public boolean equals(Object o) {
057        if (this == o) {
058          return true;
059        }
060        if ( !(o instanceof CodeColorizerFormat)) {
061          return false;
062        }
063    
064        CodeColorizerFormat format = (CodeColorizerFormat) o;
065        return languageKey.equals(format.languageKey);
066    
067      }
068    
069      @Override
070      public int hashCode() {
071        return languageKey.hashCode();
072      }
073    
074      @Override
075      public String toString() {
076        return Objects.toStringHelper(this)
077          .add("lang", languageKey)
078          .toString();
079      }
080    }