You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2015/04/10 18:45:27 UTC
svn commit: r1672699 - in
/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier:
ConsoleVerificationResultPrinter.java VerificationResult.java
VerificationResultPrinter.java VerifierMojo.java
Author: khmarbaise
Date: Fri Apr 10 16:45:27 2015
New Revision: 1672699
URL: http://svn.apache.org/r1672699
Log:
Fixed checkstyle reported issues.
Modified:
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/ConsoleVerificationResultPrinter.java
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResult.java
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResultPrinter.java
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
Modified: maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/ConsoleVerificationResultPrinter.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/ConsoleVerificationResultPrinter.java?rev=1672699&r1=1672698&r2=1672699&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/ConsoleVerificationResultPrinter.java (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/ConsoleVerificationResultPrinter.java Fri Apr 10 16:45:27 2015
@@ -29,11 +29,17 @@ public class ConsoleVerificationResultPr
{
private Log log;
+ /**
+ * @param log {@link Log}
+ */
public ConsoleVerificationResultPrinter( Log log )
{
this.log = log;
}
+ /**
+ * {@inheritDoc}
+ */
public void print( VerificationResult results )
{
printExistenceFailures( results );
Modified: maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResult.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResult.java?rev=1672699&r1=1672698&r2=1672699&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResult.java (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResult.java Fri Apr 10 16:45:27 2015
@@ -35,36 +35,61 @@ public class VerificationResult
private List contentFailures = new ArrayList();
+ /**
+ * @param file {@link File}
+ */
public void addExistenceFailure( File file )
{
existenceFailures.add( file );
}
+ /**
+ * Added non existence failure.
+ *
+ * @param file {@linke File}
+ */
public void addNonExistenceFailure( File file )
{
nonExistenceFailures.add( file );
}
+ /**
+ * Add content failure.
+ *
+ * @param file {@link File}
+ */
public void addContentFailure( File file )
{
contentFailures.add( file );
}
+ /**
+ * @return {@link #existenceFailures}
+ */
public List getExistenceFailures()
{
return existenceFailures;
}
+ /**
+ * @return {@link #nonExistenceFailures}
+ */
public List getNonExistenceFailures()
{
return nonExistenceFailures;
}
+ /**
+ * @return {@link #contentFailures}
+ */
public List getContentFailures()
{
return contentFailures;
}
+ /**
+ * @return true if a failures exists false otherwise.
+ */
public boolean hasFailures()
{
return !getExistenceFailures().isEmpty() || !getNonExistenceFailures().isEmpty()
Modified: maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResultPrinter.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResultPrinter.java?rev=1672699&r1=1672698&r2=1672699&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResultPrinter.java (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerificationResultPrinter.java Fri Apr 10 16:45:27 2015
@@ -24,5 +24,8 @@ package org.apache.maven.plugin.verifier
*/
public interface VerificationResultPrinter
{
+ /**
+ * @param result {@link VerificationResult}
+ */
void print( VerificationResult result );
}
Modified: maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java?rev=1672699&r1=1672698&r2=1672699&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java Fri Apr 10 16:45:27 2015
@@ -56,9 +56,10 @@ public class VerifierMojo
/**
* The file containing the verifications to perform.
*/
- @Parameter( property = "verifier.verificationFile", defaultValue = "${basedir}/src/test/verifier/verifications.xml",
- required = true )
+ // CHECKSTYLE_OFF: LineLength
+ @Parameter( property = "verifier.verificationFile", defaultValue = "${basedir}/src/test/verifier/verifications.xml", required = true )
private File verificationFile;
+ // CHECKSTYLE_ON: LineLength
/**
* Whether the build will fail on verification errors.
@@ -68,6 +69,9 @@ public class VerifierMojo
private VerificationResultPrinter resultPrinter = new ConsoleVerificationResultPrinter( getLog() );
+ /**
+ * {@inheritDoc}
+ */
public void execute()
throws MojoExecutionException
{
@@ -83,7 +87,7 @@ public class VerifierMojo
/**
* @param file the file path of the file to check (can be relative or absolute). If relative
- * the project's basedir will be prefixed.
+ * the project's basedir will be prefixed.
* @return the absolute file path of the file to check
*/
protected File getAbsoluteFileToCheck( File file )
@@ -154,8 +158,8 @@ public class VerifierMojo
return result;
}
- private boolean verifyFileContent( org.apache.maven.plugin.verifier.model.File fileCheck,
- VerificationResult results )
+ // CHECKSTYLE_OFF: LineLength
+ private boolean verifyFileContent( org.apache.maven.plugin.verifier.model.File fileCheck, VerificationResult results )
throws IOException
{
boolean result = false;
@@ -179,6 +183,7 @@ public class VerifierMojo
return result;
}
+ // CHECKSTYLE_ON: LineLength
private boolean verifyFileExistence( org.apache.maven.plugin.verifier.model.File fileCheck,
VerificationResult results )
@@ -208,21 +213,34 @@ public class VerifierMojo
return result;
}
- public void setBaseDir( File basedir )
+ /**
+ * @param theBasedir Set the base directory.
+ */
+ public void setBaseDir( File theBasedir )
{
- this.basedir = basedir;
+ this.basedir = theBasedir;
}
+ /**
+ * @param file Set the file for verification.
+ */
public void setVerificationFile( File file )
{
this.verificationFile = file;
}
+ /**
+ * @param printer The verification result printer.
+ * @see {@link VerificationResultPrinter}
+ */
public void setVerificationResultPrinter( VerificationResultPrinter printer )
{
this.resultPrinter = printer;
}
+ /**
+ * @param failOnError true to fail on error false otherwise.
+ */
public void setFailOnError( boolean failOnError )
{
this.failOnError = failOnError;