001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 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 */
020package org.sonar.api.web;
021
022import java.util.List;
023
024import org.sonar.api.ServerExtension;
025import org.sonar.colorizer.Tokenizer;
026
027/**
028 * Extend the library sonar-colorizer to support new languages. By default only Java sources are colorized in Sonar.
029 * 
030 * @since 1.12
031 */
032public abstract class CodeColorizerFormat implements ServerExtension {
033
034  private String languageKey;
035
036  /**
037   * @param languageKey the unique sonar key. Not null.
038   */
039  protected CodeColorizerFormat(String languageKey) {
040    this.languageKey = languageKey;
041  }
042
043  public final String getLanguageKey() {
044    return languageKey;
045  }
046
047  /**
048   * sonar-colorizer tokenizers for HTML output.
049   * 
050   * @return a not null list (empty if no tokenizers)
051   */
052  public abstract List<Tokenizer> getTokenizers();
053
054  @Override
055  public boolean equals(Object o) {
056    if (this == o) {
057      return true;
058    }
059    if ( !(o instanceof CodeColorizerFormat)) {
060      return false;
061    }
062
063    CodeColorizerFormat format = (CodeColorizerFormat) o;
064    return languageKey.equals(format.languageKey);
065
066  }
067
068  @Override
069  public int hashCode() {
070    return languageKey.hashCode();
071  }
072}