org.sonar.plugins.scala.language
Class Comment

java.lang.Object
  org.sonar.plugins.scala.language.Comment

public class Comment
extends Object

This class implements a Scala comment and the computation of several base metrics for a comment.

Since:

0.1

Author:

Felix Müller

Constructor Summary

Comment(String content, CommentType type)

Method Summary

boolean	equals(Object obj)
int	getNumberOfBlankLines()
int	getNumberOfCommentedOutLinesOfCode()
int	getNumberOfLines()
int	hashCode()
boolean	isDocComment()
boolean	isHeaderComment()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

public Comment(String content,
               CommentType type)
        throws IOException

Throws:

IOException

Method Detail

getNumberOfLines

public int getNumberOfLines()

getNumberOfBlankLines

public int getNumberOfBlankLines()

getNumberOfCommentedOutLinesOfCode

public int getNumberOfCommentedOutLinesOfCode()

isDocComment

public boolean isDocComment()

isHeaderComment

public boolean isHeaderComment()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object