DetectorOptions (checkstyle 8.36.1 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions

public final class DetectorOptions
extends java.lang.Object

Options for a detector.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class DetectorOptions.Builder
Class which implements Builder pattern to build DetectorOptions instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getFormat()`	Format of the regular expression.
`int`	`getMaximum()`	The maximum number of allowed detections.
`java.lang.String`	`getMessage()`	The message to report violations with.
`int`	`getMinimum()`	The minimum number of allowed detections.
`java.util.regex.Pattern`	`getPattern()`	The pattern to use when matching.
`AbstractViolationReporter`	`getReporter()`	The violation reporter to use.
`MatchSuppressor`	`getSuppressor()`	The suppressor to use.
`static DetectorOptions.Builder`	`newBuilder()`	Returns new Builder object.

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

- Method Detail
  - newBuilder
```
public static DetectorOptions.Builder newBuilder()
```
    Returns new Builder object.
    
    Returns:
    
    Builder object.
  - getFormat
```
public java.lang.String getFormat()
```
    Format of the regular expression.
    
    Returns:
    
    format of the regular expression.
  - getReporter
```
public AbstractViolationReporter getReporter()
```
    The violation reporter to use.
    
    Returns:
    
    the violation reporter to use.
  - getMessage
```
public java.lang.String getMessage()
```
    The message to report violations with.
    
    Returns:
    
    the message to report violations with.
  - getMinimum
```
public int getMinimum()
```
    The minimum number of allowed detections.
    
    Returns:
    
    the minimum number of allowed detections.
  - getMaximum
```
public int getMaximum()
```
    The maximum number of allowed detections.
    
    Returns:
    
    the maximum number of allowed detections.
  - getSuppressor
```
public MatchSuppressor getSuppressor()
```
    The suppressor to use.
    
    Returns:
    
    the suppressor to use.
  - getPattern
```
public java.util.regex.Pattern getPattern()
```
    The pattern to use when matching.
    
    Returns:
    
    the pattern to use when matching.