rulebook-checkstyle/com.hanggrian.rulebook.checkstyle.checks/BlockCommentTrimCheck

BlockCommentTrimCheck

class BlockCommentTrimCheck : AbstractJavadocCheck

Constructors

BlockCommentTrimCheck

constructor()

Properties

acceptableJavadocTokens

open val acceptableJavadocTokens: IntArray?

acceptableTokens

val acceptableTokens: IntArray?

defaultJavadocTokens

open override val defaultJavadocTokens: IntArray

val defaultTokens: IntArray?

var fileContents: FileContents?

val filePath: String?

var id: String?

isCommentNodesRequired

val isCommentNodesRequired: Boolean

val lines: Array<out String?>?

requiredJavadocTokens

open val requiredJavadocTokens: IntArray?

val requiredTokens: IntArray?

var severity: String?

val severityLevel: SeverityLevel?

protected var tabWidth: Int

val tokenNames: Set<String?>?

open val violations: SortedSet<Violation?>?

Functions

acceptJavadocWithNonTightHtml

open fun acceptJavadocWithNonTightHtml(): Boolean

beginJavadocTree

open fun beginJavadocTree(rootAst: DetailNode?)

fun beginTree(rootAST: DetailAST?)

clearViolations

fun clearViolations()

fun configure(config: Configuration?)

fun contextualize(context: Context?)

open fun destroy()

finishJavadocTree

open fun finishJavadocTree(rootAst: DetailNode?)

fun finishTree(rootAST: DetailAST?)

getDefaultJavadocTokens

open override fun getDefaultJavadocTokens(): IntArray

fun getLine(index: Int): String?

getLineCodePoints

fun getLineCodePoints(index: Int): IntArray?

open fun init()

leaveJavadocToken

open fun leaveJavadocToken(ast: DetailNode?)

open fun leaveToken(ast: DetailAST?)

fun log(ast: DetailAST?, key: String?, vararg args: Any?)

fun log(line: Int, key: String?, vararg args: Any?)

fun log(lineNo: Int, colNo: Int, key: String?, vararg args: Any?)

setJavadocTokens

open fun setJavadocTokens(vararg strRep: String?)

fun setTokens(vararg strRep: String?)

setViolateExecutionOnNonTightHtml

open fun setViolateExecutionOnNonTightHtml(shouldReportViolation: Boolean)

visitJavadocToken

open override fun visitJavadocToken(node: DetailNode)

fun visitToken(blockCommentNode: DetailAST?)