com.github.sbaudoin.sonar.plugins.shellcheck.measures

Class LineCountData

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.measures.LineCountData

public class LineCountData
extends Object

Bean that holds a summary of the lines of a source file (total number of lines, actual line numbers of line of code and line numbers of comments)

Constructor Summary

Constructors

Constructor and Description
LineCountData(Integer linesNumber, Set<Integer> linesOfCodeLines, Set<Integer> effectiveCommentLine) Constructor

Method Summary

Modifier and Type	Method and Description
Set<Integer>	effectiveCommentLines() Returns the set of line numbers of comments
Integer	linesNumber() Returns the total number of lines of code
Set<Integer>	linesOfCodeLines() Returns the set of line numbers of lines of code

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineCountData

public LineCountData(Integer linesNumber,
                     Set<Integer> linesOfCodeLines,
                     Set<Integer> effectiveCommentLine)

Constructor

Parameters:

linesNumber - a number of lines

linesOfCodeLines - set of line numbers of line of code

effectiveCommentLine - set of line numbers of comments

Method Detail

linesNumber

public Integer linesNumber()

Returns the total number of lines of code

Returns:

the total number of lines of code

linesOfCodeLines

public Set<Integer> linesOfCodeLines()

Returns the set of line numbers of lines of code

Returns:

the set of line numbers of lines of code

effectiveCommentLines

public Set<Integer> effectiveCommentLines()

Returns the set of line numbers of comments

Returns:

the set of line numbers of comments