Check (com.spotify.fmt:fmt-maven-plugin 2.17 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - com.spotify.fmt.AbstractFMT
  - - com.spotify.fmt.Check

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="check",
      defaultPhase=VERIFY,
      threadSafe=true)
public class Check
extends AbstractFMT
```
Check mojo that will ensure all files are formatted. If some files are not formatted, an exception is thrown.

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor Description

Check()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getProcessingLabel()`	Provides the name of the label used when a non-formatted file is found.
`protected void`	`postExecute(com.spotify.fmt.FormattingResult result)`	Post Execute action.
`protected boolean`	`shouldWriteReformattedFiles()`	Whether to write reformatted files to disk.

Methods inherited from class com.spotify.fmt.AbstractFMT
execute, getResult

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

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

- Constructor Detail
  - Check
```
public Check()
```
- Method Detail
  - postExecute
```
protected void postExecute(com.spotify.fmt.FormattingResult result)
                    throws org.apache.maven.plugin.MojoFailureException
```
    Post Execute action. It is called at the end of the execute method. Subclasses can add extra checks.
    
    Overrides:
    
    postExecute in class AbstractFMT
    
    Parameters:
    
    result - The formatting result
    
    Throws:
    
    org.apache.maven.plugin.MojoFailureException - if there is an exception
  - shouldWriteReformattedFiles
```
protected boolean shouldWriteReformattedFiles()
```
    Description copied from class: AbstractFMT
    
    Whether to write reformatted files to disk.
    
    Specified by:
    
    shouldWriteReformattedFiles in class AbstractFMT
  - getProcessingLabel
```
protected String getProcessingLabel()
```
    Provides the name of the label used when a non-formatted file is found.
    
    Specified by:
    
    getProcessingLabel in class AbstractFMT
    
    Returns:
    
    the label to use in the log