org.sonar.api.batch.sensor.highlighting
Enum TypeOfText

java.lang.Object
  extended by java.lang.Enum<TypeOfText>
      extended by org.sonar.api.batch.sensor.highlighting.TypeOfText
All Implemented Interfaces:
Serializable, Comparable<TypeOfText>

@Beta
public enum TypeOfText
extends Enum<TypeOfText>

Experimental, do not use.

Possible types for highlighting code. See sonar-colorizer.css

Since:
4.5

Enum Constant Summary
ANNOTATION
           
COMMENT
           
CONSTANT
           
CPP_DOC
          Deprecated. use COMMENT
KEYWORD
           
KEYWORD_LIGHT
           
PREPROCESS_DIRECTIVE
           
STRING
           
STRUCTURED_COMMENT
          For example Javadoc
 
Method Summary
 String cssClass()
          For internal use
static TypeOfText forCssClass(String cssClass)
           
static TypeOfText valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TypeOfText[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ANNOTATION

public static final TypeOfText ANNOTATION

CONSTANT

public static final TypeOfText CONSTANT

COMMENT

public static final TypeOfText COMMENT

CPP_DOC

@Deprecated
public static final TypeOfText CPP_DOC
Deprecated. use COMMENT

STRUCTURED_COMMENT

public static final TypeOfText STRUCTURED_COMMENT
For example Javadoc


KEYWORD

public static final TypeOfText KEYWORD

STRING

public static final TypeOfText STRING

KEYWORD_LIGHT

public static final TypeOfText KEYWORD_LIGHT

PREPROCESS_DIRECTIVE

public static final TypeOfText PREPROCESS_DIRECTIVE
Method Detail

values

public static TypeOfText[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (TypeOfText c : TypeOfText.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static TypeOfText valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

forCssClass

public static TypeOfText forCssClass(String cssClass)

cssClass

public String cssClass()
For internal use



Copyright © 2009–2015 SonarSource. All rights reserved.