org.sonar.plugins.scala.language
Enum CommentType

java.lang.Object
  extended by java.lang.Enum<CommentType>
      extended by org.sonar.plugins.scala.language.CommentType
All Implemented Interfaces:
Serializable, Comparable<CommentType>

public enum CommentType
extends Enum<CommentType>

This enum is a helper to distinguish between the different types of comments in Sonar.

Since:
0.1
Author:
Felix Müller

Enum Constant Summary
DOC
           
HEADER
           
NORMAL
           
 
Method Summary
static CommentType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CommentType[] 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

NORMAL

public static final CommentType NORMAL

DOC

public static final CommentType DOC

HEADER

public static final CommentType HEADER
Method Detail

values

public static CommentType[] 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 (CommentType c : CommentType.values())
    System.out.println(c);

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

valueOf

public static CommentType 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


Copyright © 2002–2015 InfoEther. All rights reserved.