MultiLineCommentCheck (qulice-checkstyle 0.24.0 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractCheck
    - - com.qulice.checkstyle.MultiLineCommentCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
```
public final class MultiLineCommentCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
```
Multi line comment checker. Used by the checkstyle process multiple times as a singleton.

Since:

0.23.1

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
  com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions

Constructor Summary

Constructors
Constructor Description

MultiLineCommentCheck()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int[]`	`getAcceptableTokens()`
`int[]`	`getDefaultTokens()`
`int[]`	`getRequiredTokens()`
`boolean`	`isCommentNodesRequired()`
`void`	`setFormat(String fmt)`	The method is called from checkstyle to configure this class.
`void`	`setMessage(String msg)`	The method is called from checkstyle to configure this class.
`void`	`visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)`

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MultiLineCommentCheck
```
public MultiLineCommentCheck()
```
- Method Detail
  - isCommentNodesRequired
```
public boolean isCommentNodesRequired()
```
    Overrides:
    
    isCommentNodesRequired in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - getDefaultTokens
```
public int[] getDefaultTokens()
```
    Specified by:
    
    getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - getAcceptableTokens
```
public int[] getAcceptableTokens()
```
    Specified by:
    
    getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - getRequiredTokens
```
public int[] getRequiredTokens()
```
    Specified by:
    
    getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - visitToken
```
public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
```
    Overrides:
    
    visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - setFormat
```
public void setFormat(String fmt)
```
    The method is called from checkstyle to configure this class. The parameter is set from the checks.xml file and property
    
    Parameters:
    
    fmt - Validatig regexp.
  - setMessage
```
public void setMessage(String msg)
```
    The method is called from checkstyle to configure this class. The parameter is set from the checks.xml file and property
    
    Parameters:
    
    msg - Error message.