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