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.api.web;
021    
022    import org.sonar.api.ServerExtension;
023    import org.sonar.channel.Channel;
024    import org.sonar.colorizer.HtmlCodeBuilder;
025    import org.sonar.colorizer.Tokenizer;
026    
027    import java.util.List;
028    
029    /**
030     * Extend the library sonar-colorizer to support new languages. By default only Java sources are colorized in Sonar.
031     *
032     * @since 1.12
033     */
034    public abstract class CodeColorizerFormat implements ServerExtension {
035    
036      private String languageKey;
037    
038      /**
039       * @param languageKey the unique sonar key. Not null.
040       */
041      protected CodeColorizerFormat(String languageKey) {
042        this.languageKey = languageKey;
043      }
044    
045      public final String getLanguageKey() {
046        return languageKey;
047      }
048    
049      /**
050       * sonar-colorizer tokenizers for HTML output.
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    }