org.sonar.plugins.scala.language

Class Comment

java.lang.Object

org.sonar.plugins.scala.language.Comment

public class Comment
extends java.lang.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

Constructors

Constructor and Description
Comment(java.lang.String content, CommentType type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getNumberOfBlankLines()
int	getNumberOfCommentedOutLinesOfCode()
int	getNumberOfLines()
int	hashCode()
boolean	isDocComment()
boolean	isHeaderComment()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Comment

public Comment(java.lang.String content,
               CommentType type)
        throws java.io.IOException

Throws:

java.io.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 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object