IgnoreCommand (sonar-plugin-api 8.9)

@ScannerSide
public interface IgnoreCommand

Since:: 7.6

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clean()`	To be called after the last call to `isIgnored(Path)`.
`void`	`init(java.nio.file.Path baseDir)`	Must be called before the calling `isIgnored(Path)` It should contains any operation (e.g.
`boolean`	`isIgnored(java.nio.file.Path file)`	Check if a file is ignored by the scm.

- Method Detail
  - isIgnored
```
boolean isIgnored(java.nio.file.Path file)
```
    Check if a file is ignored by the scm. init(Path) must be called before the first call to this method and clean() after the last one
    
    Parameters:
    
    file - Absolute path of a project file
    
    Returns:
    
    true if the given file is ignored by the scm, false otherwise
  - init
```
void init(java.nio.file.Path baseDir)
```
    Must be called before the calling isIgnored(Path) It should contains any operation (e.g. building cache) required before handling isIgnored(Path) calls.
    
    Parameters:
    
    baseDir - the root directory of the project
  - clean
```
void clean()
```
    To be called after the last call to isIgnored(Path). Cache or any other resources used should be cleared.