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/11/28 15:47:05 UTC
svn commit: r1716978 - in
/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter:
./ collection/ resolve/ resolve/transform/
Author: khmarbaise
Date: Sat Nov 28 14:47:04 2015
New Revision: 1716978
URL: http://svn.apache.org/viewvc?rev=1716978&view=rev
Log:
Fixed large number of Checkstyle reported errors/warnings.
Modified:
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/AbstractStrictPatternArtifactFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternExcludesArtifactFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternIncludesArtifactFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/ScopeArtifactFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/StatisticsReportingArtifactFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactFeatureFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactsFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactFilterException.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactTransitivityFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactsFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ClassifierFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/FilterArtifacts.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ProjectTransitivityFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ScopeFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/TypeFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/AbstractFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ExclusionsFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/Node.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ScopeFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/transform/ArtifactIncludeNode.java
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/AbstractStrictPatternArtifactFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/AbstractStrictPatternArtifactFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/AbstractStrictPatternArtifactFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/AbstractStrictPatternArtifactFilter.java Sat Nov 28 14:47:04 2015
@@ -79,9 +79,7 @@ public abstract class AbstractStrictPatt
// ArtifactFilter methods -------------------------------------------------
- /*
- * @see org.apache.maven.artifact.resolver.filter.ArtifactFilter#include(org.apache.maven.artifact.Artifact)
- */
+ /** {@inheritDoc} */
public boolean include( Artifact artifact )
{
boolean matched = false;
@@ -121,7 +119,7 @@ public abstract class AbstractStrictPatt
String[] patternTokens = pattern.split( ":" );
// fail immediately if pattern tokens outnumber tokens to match
- boolean matched = ( patternTokens.length <= tokens.length );
+ boolean matched = patternTokens.length <= tokens.length;
for ( int i = 0; matched && i < patternTokens.length; i++ )
{
@@ -154,7 +152,7 @@ public abstract class AbstractStrictPatt
{
String contains = pattern.substring( 1, pattern.length() - 1 );
- matches = ( token.contains( contains ) );
+ matches = token.contains( contains );
}
// support leading wildcard
else if ( pattern.startsWith( "*" ) )
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternExcludesArtifactFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternExcludesArtifactFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternExcludesArtifactFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternExcludesArtifactFilter.java Sat Nov 28 14:47:04 2015
@@ -32,16 +32,24 @@ import org.apache.maven.artifact.Artifac
public class PatternExcludesArtifactFilter
extends PatternIncludesArtifactFilter
{
+ /**
+ * @param patterns The pattern to be used.
+ */
public PatternExcludesArtifactFilter( Collection<String> patterns )
{
super( patterns );
}
+ /**
+ * @param patterns The pattern which will be used.
+ * @param actTransitively yes/no.
+ */
public PatternExcludesArtifactFilter( Collection<String> patterns, boolean actTransitively )
{
super( patterns, actTransitively );
}
+ /** {@inheritDoc} */
public boolean include( Artifact artifact )
{
boolean shouldInclude = !patternMatches( artifact );
@@ -54,11 +62,13 @@ public class PatternExcludesArtifactFilt
return shouldInclude;
}
+ /** {@inheritDoc} */
protected String getFilterDescription()
{
return "artifact exclusion filter";
}
+ /** {@inheritDoc} */
public String toString()
{
return "Excludes filter:" + getPatternsAsString();
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternIncludesArtifactFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternIncludesArtifactFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternIncludesArtifactFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/PatternIncludesArtifactFilter.java Sat Nov 28 14:47:04 2015
@@ -52,6 +52,9 @@ public class PatternIncludesArtifactFilt
private final List<String> filteredArtifactIds = new ArrayList<String>();
+ /**
+ * @param patterns The pattern to be used.
+ */
public PatternIncludesArtifactFilter( final Collection<String> patterns )
{
this( patterns, false );
@@ -64,12 +67,16 @@ public class PatternIncludesArtifactFilt
this( (Collection) patterns, actTransitively );
}
+ /**
+ * @param patterns The pattern to be used.
+ * @param actTransitively transitive yes/no.
+ */
public PatternIncludesArtifactFilter( final Collection<String> patterns, final boolean actTransitively )
{
this.actTransitively = actTransitively;
final List<String> pos = new ArrayList<String>();
final List<String> neg = new ArrayList<String>();
- if ( ( patterns != null ) && !patterns.isEmpty() )
+ if ( patterns != null && !patterns.isEmpty() )
{
for ( String pattern : patterns )
{
@@ -88,6 +95,7 @@ public class PatternIncludesArtifactFilt
negativePatterns = neg;
}
+ /** {@inheritDoc} */
public boolean include( final Artifact artifact )
{
final boolean shouldInclude = patternMatches( artifact );
@@ -100,11 +108,18 @@ public class PatternIncludesArtifactFilt
return shouldInclude;
}
+ /**
+ * @param artifact to check for.
+ * @return true if the match is true false otherwise.
+ */
protected boolean patternMatches( final Artifact artifact )
{
- return ( positiveMatch( artifact ) == Boolean.TRUE ) || ( negativeMatch( artifact ) == Boolean.FALSE );
+ return positiveMatch( artifact ) == Boolean.TRUE || negativeMatch( artifact ) == Boolean.FALSE;
}
+ /**
+ * @param artifactId add artifact to the filtered artifacts list.
+ */
protected void addFilteredArtifactId( final String artifactId )
{
filteredArtifactIds.add( artifactId );
@@ -112,7 +127,7 @@ public class PatternIncludesArtifactFilt
private Boolean negativeMatch( final Artifact artifact )
{
- if ( ( negativePatterns == null ) || negativePatterns.isEmpty() )
+ if ( negativePatterns == null || negativePatterns.isEmpty() )
{
return null;
}
@@ -122,9 +137,13 @@ public class PatternIncludesArtifactFilt
}
}
+ /**
+ * @param artifact check for positive match.
+ * @return true/false.
+ */
protected Boolean positiveMatch( final Artifact artifact )
{
- if ( ( positivePatterns == null ) || positivePatterns.isEmpty() )
+ if ( positivePatterns == null || positivePatterns.isEmpty() )
{
return null;
}
@@ -159,7 +178,7 @@ public class PatternIncludesArtifactFilt
{
final List<String> depTrail = artifact.getDependencyTrail();
- if ( ( depTrail != null ) && depTrail.size() > 1 )
+ if ( depTrail != null && depTrail.size() > 1 )
{
for ( String trailItem : depTrail )
{
@@ -182,7 +201,7 @@ public class PatternIncludesArtifactFilt
final String[] patternTokens = pattern.split( ":" );
// fail immediately if pattern tokens outnumber tokens to match
- boolean matched = ( patternTokens.length <= tokens.length );
+ boolean matched = patternTokens.length <= tokens.length;
for ( int i = 0; matched && i < patternTokens.length; i++ )
{
@@ -244,7 +263,7 @@ public class PatternIncludesArtifactFilt
{
final String contains = pattern.substring( 1, pattern.length() - 1 );
- matches = ( token.contains( contains ) );
+ matches = token.contains( contains );
}
// support leading wildcard
else if ( pattern.startsWith( "*" ) )
@@ -307,6 +326,7 @@ public class PatternIncludesArtifactFilt
}
}
+ /** {@inheritDoc} */
public void reportMissedCriteria( final Logger logger )
{
// if there are no patterns, there is nothing to report.
@@ -344,6 +364,9 @@ public class PatternIncludesArtifactFilt
return "Includes filter:" + getPatternsAsString();
}
+ /**
+ * @return pattern as a string.
+ */
protected String getPatternsAsString()
{
final StringBuilder buffer = new StringBuilder();
@@ -355,11 +378,15 @@ public class PatternIncludesArtifactFilt
return buffer.toString();
}
+ /**
+ * @return description.
+ */
protected String getFilterDescription()
{
return "artifact inclusion filter";
}
+ /** {@inheritDoc} */
public void reportFilteredArtifacts( final Logger logger )
{
if ( !filteredArtifactIds.isEmpty() && logger.isDebugEnabled() )
@@ -376,6 +403,7 @@ public class PatternIncludesArtifactFilt
}
}
+ /** {@inheritDoc} */
public boolean hasMissedCriteria()
{
// if there are no patterns, there is nothing to report.
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/ScopeArtifactFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/ScopeArtifactFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/ScopeArtifactFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/ScopeArtifactFilter.java Sat Nov 28 14:47:04 2015
@@ -106,6 +106,7 @@ public class ScopeArtifactFilter
}
}
+ /** {@inheritDoc} */
public boolean include( Artifact artifact )
{
boolean result = true;
@@ -162,6 +163,9 @@ public class ScopeArtifactFilter
return result;
}
+ /**
+ * @return Information converted to a string.
+ */
public String toString()
{
return "Scope filter [null-scope=" + includeNullScope + ", compile=" + includeCompileScope + ", runtime="
@@ -169,6 +173,7 @@ public class ScopeArtifactFilter
+ includeSystemScope + "]";
}
+ /** {@inheritDoc} */
public void reportFilteredArtifacts( Logger logger )
{
if ( !filteredArtifactIds.isEmpty() && logger.isDebugEnabled() )
@@ -184,6 +189,7 @@ public class ScopeArtifactFilter
}
}
+ /** {@inheritDoc} */
public void reportMissedCriteria( Logger logger )
{
if ( logger.isDebugEnabled() )
@@ -229,6 +235,7 @@ public class ScopeArtifactFilter
}
}
+ /** {@inheritDoc} */
public boolean hasMissedCriteria()
{
boolean report = false;
@@ -261,62 +268,94 @@ public class ScopeArtifactFilter
return report;
}
+ /**
+ * @return {@link #includeCompileScope}
+ */
public boolean isIncludeCompileScope()
{
return includeCompileScope;
}
- public ScopeArtifactFilter setIncludeCompileScope( boolean includeCompileScope )
+ /**
+ * @param pIncludeCompileScope true/false.
+ * @return {@link ScopeArtifactFilter}
+ */
+ public ScopeArtifactFilter setIncludeCompileScope( boolean pIncludeCompileScope )
{
- this.includeCompileScope = includeCompileScope;
+ this.includeCompileScope = pIncludeCompileScope;
return this;
}
+ /**
+ * @return {@link #includeRuntimeScope}
+ */
public boolean isIncludeRuntimeScope()
{
return includeRuntimeScope;
}
- public ScopeArtifactFilter setIncludeRuntimeScope( boolean includeRuntimeScope )
+ /**
+ * @param pIncludeRuntimeScope true/false
+ * @return {@link ScopeArtifactFilter}
+ */
+ public ScopeArtifactFilter setIncludeRuntimeScope( boolean pIncludeRuntimeScope )
{
- this.includeRuntimeScope = includeRuntimeScope;
+ this.includeRuntimeScope = pIncludeRuntimeScope;
return this;
}
+ /**
+ * @return {@link #includeTestScope}
+ */
public boolean isIncludeTestScope()
{
return includeTestScope;
}
- public ScopeArtifactFilter setIncludeTestScope( boolean includeTestScope )
+ /**
+ * @param pIncludeTestScope {@link #includeTestScope}
+ * @return {@link ScopeArtifactFilter}
+ */
+ public ScopeArtifactFilter setIncludeTestScope( boolean pIncludeTestScope )
{
- this.includeTestScope = includeTestScope;
+ this.includeTestScope = pIncludeTestScope;
return this;
}
+ /**
+ * @return {@link #includeProvidedScope}
+ */
public boolean isIncludeProvidedScope()
{
return includeProvidedScope;
}
- public ScopeArtifactFilter setIncludeProvidedScope( boolean includeProvidedScope )
+ /**
+ * @param pIncludeProvidedScope yes/no.
+ * @return {@link #ScopeArtifactFilter()}
+ */
+ public ScopeArtifactFilter setIncludeProvidedScope( boolean pIncludeProvidedScope )
{
- this.includeProvidedScope = includeProvidedScope;
+ this.includeProvidedScope = pIncludeProvidedScope;
return this;
}
+ /**
+ * @return {@link #includeSystemScope}
+ */
public boolean isIncludeSystemScope()
{
return includeSystemScope;
}
- public ScopeArtifactFilter setIncludeSystemScope( boolean includeSystemScope )
+ /** {@inheritDoc} */
+ public ScopeArtifactFilter setIncludeSystemScope( boolean pIncludeSystemScope )
{
- this.includeSystemScope = includeSystemScope;
+ this.includeSystemScope = pIncludeSystemScope;
return this;
}
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/StatisticsReportingArtifactFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/StatisticsReportingArtifactFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/StatisticsReportingArtifactFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/StatisticsReportingArtifactFilter.java Sat Nov 28 14:47:04 2015
@@ -27,10 +27,19 @@ import org.codehaus.plexus.logging.Logge
public interface StatisticsReportingArtifactFilter
{
+ /**
+ * @param logger The logger.
+ */
void reportMissedCriteria( Logger logger );
+ /**
+ * @param logger The logger.
+ */
void reportFilteredArtifacts( Logger logger );
+ /**
+ * @return {@code true} if missed cireteria {@code false} otherwise.
+ */
boolean hasMissedCriteria();
}
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactFeatureFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactFeatureFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactFeatureFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactFeatureFilter.java Sat Nov 28 14:47:04 2015
@@ -44,6 +44,10 @@ public abstract class AbstractArtifactFe
*/
private List<String> excludes;
+ /**
+ * @param include comma separated list with includes.
+ * @param exclude comma separated list with excludes.
+ */
public AbstractArtifactFeatureFilter( String include, String exclude )
{
setExcludes( exclude );
@@ -146,6 +150,9 @@ public abstract class AbstractArtifactFe
*/
protected abstract String getArtifactFeature( Artifact artifact );
+ /**
+ * @param excludeString comma separated list with excludes.
+ */
public void setExcludes( String excludeString )
{
if ( StringUtils.isNotEmpty( excludeString ) )
@@ -154,6 +161,9 @@ public abstract class AbstractArtifactFe
}
}
+ /**
+ * @param includeString comma separated list with includes.
+ */
public void setIncludes( String includeString )
{
if ( StringUtils.isNotEmpty( includeString ) )
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactsFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactsFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactsFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/AbstractArtifactsFilter.java Sat Nov 28 14:47:04 2015
@@ -25,14 +25,15 @@ import java.util.Set;
import org.apache.maven.artifact.Artifact;
/**
- *
+ * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
+ * @version $Id$
*/
public abstract class AbstractArtifactsFilter
implements ArtifactsFilter
{
/**
- * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id$
+ * @param artifact {@link Artifact}
+ * @return {@code true} if artifact is includes {@code false}Â otherwise.
* @throws ArtifactFilterException when filtering fails
*/
public boolean isArtifactIncluded( Artifact artifact )
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactFilterException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactFilterException.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactFilterException.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactFilterException.java Sat Nov 28 14:47:04 2015
@@ -30,21 +30,34 @@ public class ArtifactFilterException
*/
private static final long serialVersionUID = 1L;
+ /**
+ * Create an instance.
+ */
public ArtifactFilterException()
{
super();
}
+ /**
+ * @param theMessage The message which describes what happends.
+ * @param theCause The cause.
+ */
public ArtifactFilterException( String theMessage, Throwable theCause )
{
super( theMessage, theCause );
}
+ /**
+ * @param theMessage The message which describes what happends.
+ */
public ArtifactFilterException( String theMessage )
{
super( theMessage );
}
+ /**
+ * @param theCause {@link Throwable}Â cause of the problem.
+ */
public ArtifactFilterException( Throwable theCause )
{
super( theCause );
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactTransitivityFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactTransitivityFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactTransitivityFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactTransitivityFilter.java Sat Nov 28 14:47:04 2015
@@ -173,6 +173,9 @@ public class ArtifactTransitivityFilter
}
}
+ /**
+ * {@inheritDoc}
+ */
public Set<Artifact> filter( Set<Artifact> artifacts )
{
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactsFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactsFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactsFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactsFilter.java Sat Nov 28 14:47:04 2015
@@ -33,9 +33,19 @@ import org.apache.maven.artifact.Artifac
*/
public interface ArtifactsFilter
{
+ /**
+ * @param artifacts {@link Artifact}
+ * @return Set of artifacts.
+ * @throws ArtifactFilterException in case of a failure.
+ */
Set<Artifact> filter( Set<Artifact> artifacts )
throws ArtifactFilterException;
+ /**
+ * @param artifact {@link Artifact}
+ * @return {@code true} if artifact is included {@code false} otherwise.
+ * @throws ArtifactFilterException in case of a failure.
+ */
boolean isArtifactIncluded( Artifact artifact )
throws ArtifactFilterException;
}
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ClassifierFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ClassifierFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ClassifierFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ClassifierFilter.java Sat Nov 28 14:47:04 2015
@@ -29,11 +29,16 @@ import org.apache.maven.artifact.Artifac
public class ClassifierFilter
extends AbstractArtifactFeatureFilter
{
+ /**
+ * @param include comma separated list with includes.
+ * @param exclude comma separated list with excludes.
+ */
public ClassifierFilter( String include, String exclude )
{
super( include, exclude );
}
+ /** {@inheritDoc} */
protected String getArtifactFeature( Artifact artifact )
{
return artifact.getClassifier();
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/FilterArtifacts.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/FilterArtifacts.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/FilterArtifacts.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/FilterArtifacts.java Sat Nov 28 14:47:04 2015
@@ -37,6 +37,9 @@ public class FilterArtifacts
{
private List<ArtifactsFilter> filters;
+ /**
+ * Created new instance.
+ */
public FilterArtifacts()
{
filters = new ArrayList<ArtifactsFilter>();
@@ -79,6 +82,11 @@ public class FilterArtifacts
}
}
+ /**
+ * @param artifacts The {@link Artifact}s to filter.
+ * @return The resulting artifacts set.
+ * @throws ArtifactFilterException in case of a failure.
+ */
public Set<Artifact> filter( Set<Artifact> artifacts )
throws ArtifactFilterException
{
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ProjectTransitivityFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ProjectTransitivityFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ProjectTransitivityFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ProjectTransitivityFilter.java Sat Nov 28 14:47:04 2015
@@ -36,12 +36,18 @@ public class ProjectTransitivityFilter
private Set<Artifact> directDependencies;
+ /**
+ * @param directDependencies set of direct dependencies.
+ * @param excludeTransitive {@code true} exclude transitive deps {@code false} otherwise.
+ */
public ProjectTransitivityFilter( Set<Artifact> directDependencies, boolean excludeTransitive )
{
this.excludeTransitive = excludeTransitive;
this.directDependencies = directDependencies;
}
+ /** {@inheritDoc}
+ */
public Set<Artifact> filter( Set<Artifact> artifacts )
{
// why not just take the directDependencies here?
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ScopeFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ScopeFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ScopeFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ScopeFilter.java Sat Nov 28 14:47:04 2015
@@ -39,6 +39,10 @@ public class ScopeFilter
private String excludeScope;
+ /**
+ * @param includeScope the scope to be included.
+ * @param excludeScope the scope to be excluded.
+ */
public ScopeFilter( String includeScope, String excludeScope )
{
this.includeScope = includeScope;
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/TypeFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/TypeFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/TypeFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/TypeFilter.java Sat Nov 28 14:47:04 2015
@@ -28,11 +28,16 @@ import org.apache.maven.artifact.Artifac
public class TypeFilter
extends AbstractArtifactFeatureFilter
{
+ /**
+ * @param include comma separated list with includes.
+ * @param exclude comma separated list with excludes.
+ */
public TypeFilter( String include, String exclude )
{
super( include, exclude );
}
+ /** {@inheritDoc} */
protected String getArtifactFeature( Artifact artifact )
{
return artifact.getType();
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/AbstractFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/AbstractFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/AbstractFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/AbstractFilter.java Sat Nov 28 14:47:04 2015
@@ -30,11 +30,18 @@ import java.util.List;
public abstract class AbstractFilter implements TransformableFilter
{
+ /** {@inheritDoc}
+ */
@Override
public final <T> T transform( FilterTransformer<T> transformer )
{
return transformer.transform( this );
}
+ /**
+ * @param node {@link Node}
+ * @param parents {@link Node}s.
+ * @return {@code true} / {@code false}
+ */
public abstract boolean accept( Node node, List<Node> parents );
}
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ExclusionsFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ExclusionsFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ExclusionsFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ExclusionsFilter.java Sat Nov 28 14:47:04 2015
@@ -47,6 +47,9 @@ public class ExclusionsFilter
this.excludes = Collections.unmodifiableCollection( excludes );
}
+ /**
+ * @return The list of excludes.
+ */
public final Collection<String> getExcludes()
{
return excludes;
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/Node.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/Node.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/Node.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/Node.java Sat Nov 28 14:47:04 2015
@@ -24,10 +24,12 @@ package org.apache.maven.shared.artifact
*
* @author Robert Scholte
* @since 3.0
- *
*/
public interface Node
{
+ /**
+ * @return {@link Dependency}
+ */
org.apache.maven.model.Dependency getDependency();
}
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ScopeFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ScopeFilter.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ScopeFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/ScopeFilter.java Sat Nov 28 14:47:04 2015
@@ -116,7 +116,9 @@ public class ScopeFilter implements Tran
/**
* Transform this filter to a tool specific implementation
*
+ * @param <T> The type to be used.
* @param transformer the transformer, must not be {@code null}
+ * @return T.
*/
public <T> T transform ( FilterTransformer<T> transformer )
{
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/transform/ArtifactIncludeNode.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/transform/ArtifactIncludeNode.java?rev=1716978&r1=1716977&r2=1716978&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/transform/ArtifactIncludeNode.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/transform/ArtifactIncludeNode.java Sat Nov 28 14:47:04 2015
@@ -47,7 +47,7 @@ class ArtifactIncludeNode implements Nod
@Override
public Dependency getDependency()
{
- org.apache.maven.model.Dependency mavenDependency = new org.apache.maven.model.Dependency();
+ Dependency mavenDependency = new Dependency();
mavenDependency.setGroupId( artifact.getGroupId() );
mavenDependency.setArtifactId( artifact.getArtifactId() );
mavenDependency.setVersion( artifact.getVersion() );