maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From khmarba...@apache.org
Subject svn commit: r1719050 - in /maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io: download/ location/ logging/ scan/ scan/mapping/
Date Thu, 10 Dec 2015 10:18:42 GMT
Author: khmarbaise
Date: Thu Dec 10 10:18:42 2015
New Revision: 1719050

URL: http://svn.apache.org/viewvc?rev=1719050&view=rev
Log:
Fixed checkstyle reported issues.

Modified:
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocatorStrategy.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MojoLogSink.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/AbstractResourceInclusionScanner.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/InclusionScanException.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/ResourceInclusionScanner.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/SimpleResourceInclusionScanner.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/StaleResourceScanner.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SingleTargetMapping.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SourceMapping.java
    maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SuffixMapping.java

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
Thu Dec 10 10:18:42 2015
@@ -42,7 +42,7 @@ import org.apache.maven.wagon.events.Tra
 import org.apache.maven.wagon.repository.Repository;
 
 /**
- * The Implementation of the {@link DownloadManager
+ * The Implementation of the {@link DownloadManager}
  *
  */
 public class DefaultDownloadManager
@@ -66,7 +66,7 @@ public class DefaultDownloadManager
     }
 
     /**
-     * @param wagonManager {@Link org.apache.maven.repository.legacy.WagonManager}
+     * @param wagonManager {@link org.apache.maven.repository.legacy.WagonManager}
      */
     public DefaultDownloadManager( WagonManager wagonManager )
     {

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocatorStrategy.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocatorStrategy.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocatorStrategy.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocatorStrategy.java
Thu Dec 10 10:18:42 2015
@@ -52,7 +52,7 @@ public class ArtifactLocatorStrategy
      * @param factory {@link ArtifactFactory}
      * @param resolver {@link ArtifactResolver}
      * @param localRepository {@link ArtifactRepository}
-     * @param remoteRepositories {@link RemoteRepository}
+     * @param remoteRepositories {@link ArtifactRepository}
      */
     public ArtifactLocatorStrategy( ArtifactFactory factory, ArtifactResolver resolver,
                                     ArtifactRepository localRepository, List<ArtifactRepository>
remoteRepositories )

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java
Thu Dec 10 10:18:42 2015
@@ -249,15 +249,15 @@ public class DefaultMessageHolder
             this.onDemandSink = onDemandSink;
         }
 
-        public Message setError( Throwable error )
+        public Message setError( Throwable pError )
         {
-            this.error = error;
+            this.error = pError;
             return this;
         }
 
-        public Message append( CharSequence message )
+        public Message append( CharSequence pMessage )
         {
-            this.message.append( message.toString() );
+            this.message.append( pMessage.toString() );
             return this;
         }
 

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java
Thu Dec 10 10:18:42 2015
@@ -177,7 +177,7 @@ public interface MessageHolder
     MessageHolder addSevereMessage( CharSequence messagePart );
 
     /**
-     * @param error
+     * @param error The error.
      * @return {@link MessageHolder}
      */
     MessageHolder addSevereMessage( Throwable error );

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MojoLogSink.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MojoLogSink.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MojoLogSink.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/logging/MojoLogSink.java
Thu Dec 10 10:18:42 2015
@@ -22,37 +22,49 @@ package org.apache.maven.shared.io.loggi
 import org.apache.maven.plugin.logging.Log;
 
 
+/**
+ * The Mojo Log Sink.
+ *
+ */
 public class MojoLogSink
     implements MessageSink
 {
 
     private final Log logger;
 
+    /**
+     * @param logger {@link Log}
+     */
     public MojoLogSink( Log logger )
     {
         this.logger = logger;
     }
 
+    /** {@inheritDoc} */
     public void debug( String message )
     {
         logger.debug( message );
     }
 
+    /** {@inheritDoc} */
     public void error( String message )
     {
         logger.error( message );
     }
 
+    /** {@inheritDoc} */
     public void info( String message )
     {
         logger.info( message );
     }
 
+    /** {@inheritDoc} */
     public void severe( String message )
     {
         logger.error( message );
     }
 
+    /** {@inheritDoc} */
     public void warning( String message )
     {
         logger.warn( message );

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/AbstractResourceInclusionScanner.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/AbstractResourceInclusionScanner.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/AbstractResourceInclusionScanner.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/AbstractResourceInclusionScanner.java
Thu Dec 10 10:18:42 2015
@@ -37,16 +37,26 @@ public abstract class AbstractResourceIn
 {
     private final List sourceMappings = new ArrayList();
 
+    /** {@inheritDoc} */
     public final void addSourceMapping( SourceMapping sourceMapping )
     {
         sourceMappings.add( sourceMapping );
     }
 
+    /**
+     * @return The source mapping.
+     */
     protected final List getSourceMappings()
     {
         return Collections.unmodifiableList( sourceMappings );
     }
 
+    /**
+     * @param sourceDir {@link File}
+     * @param sourceIncludes source includes.
+     * @param sourceExcludes source excludes.
+     * @return The resulting sources.
+     */
     protected String[] scanForSources( File sourceDir, Set sourceIncludes, Set sourceExcludes
)
     {
         DirectoryScanner ds = new DirectoryScanner();

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/InclusionScanException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/InclusionScanException.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/InclusionScanException.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/InclusionScanException.java
Thu Dec 10 10:18:42 2015
@@ -26,11 +26,18 @@ package org.apache.maven.shared.io.scan;
 public class InclusionScanException
     extends Exception
 {
+    /**
+     * @param message The message.
+     */
     public InclusionScanException( String message )
     {
         super( message );
     }
 
+    /**
+     * @param message The message.
+     * @param cause The cause of the error.
+     */
     public InclusionScanException( String message, Throwable cause )
     {
         super( message, cause );

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/ResourceInclusionScanner.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/ResourceInclusionScanner.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/ResourceInclusionScanner.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/ResourceInclusionScanner.java
Thu Dec 10 10:18:42 2015
@@ -30,8 +30,17 @@ import java.util.Set;
  */
 public interface ResourceInclusionScanner
 {
+    /**
+     * @param sourceMapping {@link SourceMapping}
+     */
     void addSourceMapping( SourceMapping sourceMapping );
 
+    /**
+     * @param sourceDir {@link File}
+     * @param targetDir {@link File}
+     * @return The included sources.
+     * @throws InclusionScanException in case of an error.
+     */
     Set getIncludedSources( File sourceDir, File targetDir )
         throws InclusionScanException;
 }

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/SimpleResourceInclusionScanner.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/SimpleResourceInclusionScanner.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/SimpleResourceInclusionScanner.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/SimpleResourceInclusionScanner.java
Thu Dec 10 10:18:42 2015
@@ -35,6 +35,10 @@ public class SimpleResourceInclusionScan
 
     private Set sourceExcludes;
 
+    /**
+     * @param sourceIncludes The source includes.
+     * @param sourceExcludes The source excludes.
+     */
     public SimpleResourceInclusionScanner( Set sourceIncludes, Set sourceExcludes )
     {
         this.sourceIncludes = sourceIncludes;
@@ -42,6 +46,7 @@ public class SimpleResourceInclusionScan
         this.sourceExcludes = sourceExcludes;
     }
 
+    /** {@inheritDoc} */
     public Set getIncludedSources( File sourceDir, File targetDir )
         throws InclusionScanException
     {

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/StaleResourceScanner.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/StaleResourceScanner.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/StaleResourceScanner.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/StaleResourceScanner.java
Thu Dec 10 10:18:42 2015
@@ -45,16 +45,27 @@ public class StaleResourceScanner
     //
     // ----------------------------------------------------------------------
 
+    /**
+     * Create instance with defaults.
+     */
     public StaleResourceScanner()
     {
         this( 0, Collections.singleton( "**/*" ), Collections.EMPTY_SET );
     }
 
+    /**
+     * @param lastUpdatedWithinMsecs last update within milli seconds.
+     */
     public StaleResourceScanner( long lastUpdatedWithinMsecs )
     {
         this( lastUpdatedWithinMsecs, Collections.singleton( "**/*" ), Collections.EMPTY_SET
);
     }
 
+    /**
+     * @param lastUpdatedWithinMsecs last update within milli seconds.
+     * @param sourceIncludes source includes.
+     * @param sourceExcludes source excludes.
+     */
     public StaleResourceScanner( long lastUpdatedWithinMsecs, Set sourceIncludes, Set sourceExcludes
)
     {
         this.lastUpdatedWithinMsecs = lastUpdatedWithinMsecs;
@@ -68,6 +79,7 @@ public class StaleResourceScanner
     // SourceInclusionScanner Implementation
     // ----------------------------------------------------------------------
 
+    /** {@inheritDoc} */
     public Set getIncludedSources( File sourceDir, File targetDir )
         throws InclusionScanException
     {

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SingleTargetMapping.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SingleTargetMapping.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SingleTargetMapping.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SingleTargetMapping.java
Thu Dec 10 10:18:42 2015
@@ -38,6 +38,10 @@ public class SingleTargetMapping
 
     private String outputFile;
 
+    /**
+     * @param sourceSuffix source suffix.
+     * @param outputFile output file.
+     */
     public SingleTargetMapping( String sourceSuffix, String outputFile )
     {
         this.sourceSuffix = sourceSuffix;
@@ -45,6 +49,7 @@ public class SingleTargetMapping
         this.outputFile = outputFile;
     }
 
+    /** {@inheritDoc} */
     public Set getTargetFiles( File targetDir, String source )
         throws InclusionScanException
     {

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SourceMapping.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SourceMapping.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SourceMapping.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SourceMapping.java
Thu Dec 10 10:18:42 2015
@@ -30,6 +30,12 @@ import java.util.Set;
  */
 public interface SourceMapping
 {
+    /**
+     * @param targetDir target directory.
+     * @param source source.
+     * @return list of target files.
+     * @throws InclusionScanException in case of an error.
+     */
     Set getTargetFiles( File targetDir, String source )
         throws InclusionScanException;
 }

Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SuffixMapping.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SuffixMapping.java?rev=1719050&r1=1719049&r2=1719050&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SuffixMapping.java
(original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/scan/mapping/SuffixMapping.java
Thu Dec 10 10:18:42 2015
@@ -36,6 +36,10 @@ public final class SuffixMapping
 
     private final Set targetSuffixes;
 
+    /**
+     * @param sourceSuffix source suffix.
+     * @param targetSuffix target suffix.
+     */
     public SuffixMapping( String sourceSuffix, String targetSuffix )
     {
         this.sourceSuffix = sourceSuffix;
@@ -43,6 +47,10 @@ public final class SuffixMapping
         this.targetSuffixes = Collections.singleton( targetSuffix );
     }
 
+    /**
+     * @param sourceSuffix source suffix.
+     * @param targetSuffixes target suffixes.
+     */
     public SuffixMapping( String sourceSuffix, Set targetSuffixes )
     {
         this.sourceSuffix = sourceSuffix;
@@ -50,6 +58,7 @@ public final class SuffixMapping
         this.targetSuffixes = Collections.unmodifiableSet( targetSuffixes );
     }
 
+    /** {@inheritDoc} */
     public Set getTargetFiles( File targetDir, String source )
     {
         Set targetFiles = new HashSet();



Mime
View raw message