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 */
020package org.sonar.api.batch.sensor.highlighting;
021
022import com.google.common.annotations.Beta;
023
024/**
025 * Experimental, do not use.
026 * <p/>
027 * Possible types for highlighting code. See sonar-colorizer.css
028 * @since 5.1
029 */
030@Beta
031public enum TypeOfText {
032  ANNOTATION("a"),
033  CONSTANT("c"),
034  COMMENT("cd"),
035  /**
036   * @deprecated use {@link #COMMENT}
037   */
038  @Deprecated
039  CPP_DOC("cppd"),
040  /**
041   * For example Javadoc
042   */
043  STRUCTURED_COMMENT("j"),
044  KEYWORD("k"),
045  STRING("s"),
046  KEYWORD_LIGHT("h"),
047  PREPROCESS_DIRECTIVE("p");
048
049  private final String cssClass;
050
051  private TypeOfText(String cssClass) {
052    this.cssClass = cssClass;
053  }
054
055  public static TypeOfText forCssClass(String cssClass) {
056    for (TypeOfText typeOfText : TypeOfText.values()) {
057      if (typeOfText.cssClass().equals(cssClass)) {
058        return typeOfText;
059      }
060    }
061    throw new IllegalArgumentException("No TypeOfText for CSS class " + cssClass);
062  }
063
064  /**
065   * For internal use
066   */
067  public String cssClass() {
068    return cssClass;
069  }
070}