rulebook
Toggle table of contents
0.2
jvm
Target filter
jvm
Switch theme
Search in API
Skip to content
rulebook
rulebook-codenarc
/
com.hanggrian.rulebook.codenarc.rules
/
RulebookFileRule
Rulebook
File
Rule
abstract
class
RulebookFileRule
:
AbstractRule
Rule that checks source code by the raw file.
Inheritors
BlockTagIndentationRule
BlockTagOrderRule
BlockTagPunctuationRule
CommentTrimRule
DuplicateBlankLineInCommentRule
EmptyBracesClipRule
EmptyBracketsClipRule
EmptyParenthesesClipRule
EmptyTagsClipRule
MissingBlankLineBeforeBlockTagsRule
ShortBlockCommentClipRule
TodoCommentRule
Members
Constructors
Rulebook
File
Rule
Link copied to clipboard
constructor
(
)
Properties
apply
To
File
Names
Link copied to clipboard
open
var
applyToFileNames
:
String
?
apply
To
Files
Matching
Link copied to clipboard
open
var
applyToFilesMatching
:
String
?
compiler
Phase
Link copied to clipboard
open
val
compilerPhase
:
Int
description
Link copied to clipboard
open
var
description
:
String
?
do
Not
Apply
To
File
Names
Link copied to clipboard
open
var
doNotApplyToFileNames
:
String
?
do
Not
Apply
To
Files
Matching
Link copied to clipboard
open
var
doNotApplyToFilesMatching
:
String
?
is
Enabled
Link copied to clipboard
open
var
isEnabled
:
Boolean
is
Ready
Link copied to clipboard
open
val
isReady
:
Boolean
name
Link copied to clipboard
abstract
var
name
:
String
?
priority
Link copied to clipboard
override
var
priority
:
Int
violation
Message
Link copied to clipboard
open
var
violationMessage
:
String
?
Functions
apply
To
Link copied to clipboard
abstract
fun
applyTo
(
p0
:
SourceCode
?
,
p1
:
List
<
Violation
?
>
?
)
open
fun
applyTo
(
sourceCode
:
SourceCode
?
)
:
List
<
Violation
?
>
?
get
Priority
Link copied to clipboard
override
fun
getPriority
(
)
:
Int
set
Name
Link copied to clipboard
override
fun
setName
(
name
:
String
?
)
:
Nothing
set
Priority
Link copied to clipboard
override
fun
setPriority
(
priority
:
Int
)
:
Nothing
validate
Link copied to clipboard
open
fun
validate
(
)