net.revelc.code.formatter

Class ValidateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.revelc.code.formatter.FormatterMojo

net.revelc.code.formatter.ValidateMojo

All Implemented Interfaces:

ConfigurationSource, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="validate",
      defaultPhase=VALIDATE,
      requiresProject=false,
      threadSafe=true)
public class ValidateMojo
extends FormatterMojo

This mojo is very similar to Formatter mojo, but it is focused on CI servers. If the code ain't formatted as expected this mojo will fail the build

Author:

marvin.froeder

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ValidateMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doFormatFile(File file, net.revelc.code.formatter.FormatterMojo.ResultCollector rc, Properties hashCache, String basedirPath, boolean dryRun) Format individual file.
void	execute() Execute.

Methods inherited from class net.revelc.code.formatter.FormatterMojo

getCompilerCodegenTargetPlatform, getCompilerCompliance, getCompilerSources, getEncoding, getTargetDirectory

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

Methods inherited from interface net.revelc.code.formatter.ConfigurationSource

getLog

Constructor Detail

ValidateMojo

public ValidateMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Description copied from class: FormatterMojo

Execute.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class FormatterMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

doFormatFile

protected void doFormatFile(File file,
                            net.revelc.code.formatter.FormatterMojo.ResultCollector rc,
                            Properties hashCache,
                            String basedirPath,
                            boolean dryRun)
                     throws IOException,
                            org.apache.maven.plugin.MojoFailureException,
                            org.eclipse.jface.text.BadLocationException,
                            org.apache.maven.plugin.MojoExecutionException

Description copied from class: FormatterMojo

Format individual file.

Overrides:

doFormatFile in class FormatterMojo

Parameters:

file - the file

rc - the rc

hashCache - the hash cache

basedirPath - the basedir path

Throws:

IOException - Signals that an I/O exception has occurred.

org.eclipse.jface.text.BadLocationException - the bad location exception

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException