You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2015/06/14 13:36:28 UTC
svn commit: r1685387 - in
/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter:
./ collection/ resolve/
Author: rfscholte
Date: Sun Jun 14 11:36:28 2015
New Revision: 1685387
URL: http://svn.apache.org/r1685387
Log:
Fix javadoc based on errors/warnings when using Java8. (includes usage of html, not xhtml)
Modified:
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/collection/AbstractArtifactsFilter.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactIdFilter.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/FilterArtifacts.java
maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/GroupIdFilter.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/resolve/ExclusionsFilter.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/TransformableFilter.java
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -28,10 +28,10 @@ import org.apache.maven.artifact.resolve
import org.codehaus.plexus.logging.Logger;
/**
- * {@link ArtifactFilter} implementation that selects artifacts based on their
- * scopes.
- * <br/>
- * <b>NOTE:</b> None of the fine-grained scopes imply other scopes when enabled;
+ * <p>
+ * {@link ArtifactFilter} implementation that selects artifacts based on their scopes.
+ * </p>
+ * <strong>NOTE:</strong> None of the fine-grained scopes imply other scopes when enabled;
* when fine-grained scope control is used, each scope must be enabled separately,
* UNLESS the corresponding XXXWithImplications() method is used to enable that
* scope.
@@ -79,6 +79,8 @@ public class ScopeArtifactFilter
* Constructor that uses the implied nature of Maven scopes to determine which
* artifacts to include. For instance, 'test' scope implies compile, provided, and runtime,
* while 'runtime' scope implies only compile.
+ *
+ * @param scope the scope
*/
public ScopeArtifactFilter( String scope )
{
@@ -327,6 +329,9 @@ public class ScopeArtifactFilter
* <li>provided</li>
* <li>compile</li>
* </ul>
+ *
+ * @param enabled whether specified scopes should be included
+ * @return this instance
*/
public ScopeArtifactFilter setIncludeCompileScopeWithImplications( boolean enabled )
{
@@ -344,6 +349,9 @@ public class ScopeArtifactFilter
* <li>compile</li>
* <li>runtime</li>
* </ul>
+ *
+ * @param enabled whether specified scopes should be included
+ * @return this instance
*/
public ScopeArtifactFilter setIncludeRuntimeScopeWithImplications( boolean enabled )
{
@@ -363,6 +371,9 @@ public class ScopeArtifactFilter
* <li>runtime</li>
* <li>test</li>
* </ul>
+ *
+ * @param enabled whether specified scopes should be included
+ * @return this instance
*/
public ScopeArtifactFilter setIncludeTestScopeWithImplications( boolean enabled )
{
@@ -377,6 +388,9 @@ public class ScopeArtifactFilter
/**
* Determine whether artifacts that have a null scope are included or excluded.
+ *
+ * @param enable whether null-scope should be included
+ * @return this instance
*/
public ScopeArtifactFilter setIncludeNullScope( boolean enable )
{
@@ -387,6 +401,8 @@ public class ScopeArtifactFilter
/**
* Reset hit counts and tracking of filtered artifacts, BUT NOT ENABLED SCOPES.
+ *
+ * @return this instance
*/
public ScopeArtifactFilter reset()
{
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -33,7 +33,7 @@ public abstract class AbstractArtifactsF
/**
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @version $Id$
- * @throws ArtifactFilterException
+ * @throws ArtifactFilterException when filtering fails
*/
public boolean isArtifactIncluded( Artifact artifact )
throws ArtifactFilterException
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactIdFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactIdFilter.java?rev=1685387&r1=1685386&r2=1685387&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactIdFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/ArtifactIdFilter.java Sun Jun 14 11:36:28 2015
@@ -25,7 +25,6 @@ import org.apache.maven.artifact.Artifac
* Filter on ArtifactId name
*
* @author clove
- * @see org.apache.maven.plugin.dependency.utils.filters.AbstractArtifactFeatureFilter
* @since 2.0-alpha-2
* @version $Id$
*/
@@ -35,14 +34,15 @@ public class ArtifactIdFilter
/**
* Will setup super with 'ArtifactId' as the filterType
*
- * @param include
- * @param exclude
+ * @param include comma separated list of artifactIds to include, may be {@code null}
+ * @param exclude comma separated list of artifactIds to exclude, may be {@code null}
*/
public ArtifactIdFilter( String include, String exclude )
{
super( include, exclude );
}
+ @Override
protected String getArtifactFeature( Artifact artifact )
{
return artifact.getArtifactId();
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -48,9 +48,10 @@ public class ArtifactTransitivityFilter
private Set<String> transitiveArtifacts;
/**
+ * <p>
* Use {@link org.apache.maven.execution.MavenSession#getProjectBuildingRequest()} to get the buildingRequest.
* The projectBuilder should be resolved with CDI.
- * <p/>
+ * </p>
* <pre>
* // For Mojo
* @Component
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -67,8 +67,8 @@ public class FilterArtifacts
* Inserts the specified element at the specified position in this list. Shifts the element currently at that
* position (if any) and any subsequent elements to the right (adds one to their indices).
*
- * @param index index at which the specified element is to be inserted.
- * @param element element to be inserted.
+ * @param index at which index the specified filter is to be inserted.
+ * @param filter the filter to be inserted.
* @throws IndexOutOfBoundsException if index is out of range <tt>(index < 0 || index > size())</tt>.
*/
public void addFilter( int index, ArtifactsFilter filter )
@@ -101,7 +101,7 @@ public class FilterArtifacts
}
/**
- * @return Returns the filters.
+ * @return the filters.
*/
public List<ArtifactsFilter> getFilters()
{
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/GroupIdFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/GroupIdFilter.java?rev=1685387&r1=1685386&r2=1685387&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/GroupIdFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/collection/GroupIdFilter.java Sun Jun 14 11:36:28 2015
@@ -25,7 +25,6 @@ import org.apache.maven.artifact.Artifac
* Filter on GroupId Name.
*
* @author clove
- * @see org.apache.maven.plugin.dependency.utils.filters.AbstractArtifactFeatureFilter
* @since 2.0
* @version $Id$
*/
@@ -36,30 +35,21 @@ public class GroupIdFilter
/**
* Construction will setup the super call with a filtertype of 'GroupId'
*
- * @param include
- * @param exclude
+ * @param include comma separated list of groupIds to include, may be {@code null}
+ * @param exclude comma separated list of groupIds to exclude, may be {@code null}
*/
public GroupIdFilter( String include, String exclude )
{
super( include, exclude );
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.maven.plugin.dependency.utils.filters.AbstractArtifactFeatureFilter#getArtifactFeature(org.apache.maven.artifact.Artifact)
- */
+ @Override
protected String getArtifactFeature( Artifact artifact )
{
return artifact.getGroupId();
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.maven.plugin.dependency.utils.filters.AbstractArtifactFeatureFilter#compareFeatures(String,String)
- */
-
+ @Override
protected boolean compareFeatures( String lhs, String rhs )
{
return lhs.startsWith( rhs );
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -49,11 +49,11 @@ public class ScopeFilter
* This function determines if filtering needs to be performed. Excludes are
* ignored if Includes are used.
*
- * @param dependencies
- * the set of dependencies to filter.
+ * @param artifacts
+ * the set of artifacts to filter.
*
- * @return a Set of filtered dependencies.
- * @throws ArtifactFilterException
+ * @return a Set of filtered artifacts.
+ * @throws ArtifactFilterException when there's an invalid included scope
*/
public Set<Artifact> filter( Set<Artifact> artifacts )
throws ArtifactFilterException
@@ -160,7 +160,7 @@ public class ScopeFilter
}
/**
- * @param includeScope
+ * @param scope
* The includeScope to set.
*/
public void setIncludeScope( String scope )
@@ -177,12 +177,12 @@ public class ScopeFilter
}
/**
- * @param excludeScope
+ * @param scope
* The excludeScope to set.
*/
- public void setExcludeScope( String excludeScope )
+ public void setExcludeScope( String scope )
{
- this.excludeScope = excludeScope;
+ this.excludeScope = scope;
}
}
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -40,7 +40,7 @@ public class ExclusionsFilter
* The default constructor specifying a collection of keys which must be excluded.
*
* @param excludes the keys to exclude, may not be {@code null}
- * @see Artifact#getDependencyConflictId()
+ * @see org.apache.maven.artifact.Artifact#getDependencyConflictId()
*/
public ExclusionsFilter( Collection<String> excludes )
{
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=1685387&r1=1685386&r2=1685387&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 Sun Jun 14 11:36:28 2015
@@ -24,7 +24,7 @@ import java.util.Collection;
import java.util.Collections;
/**
- * Filter based on scope. <em>Note:<em> There's no logic for inherited scoped
+ * Filter based on scope. <strong>Note:</strong> There's no logic for inherited scoped
*
* @author Robert Scholte
* @since 3.0
@@ -40,8 +40,8 @@ public class ScopeFilter implements Tran
/**
*
- * @param included specific scopes to include or {@null} to include all
- * @param excluded specific scopes to exclude or {@null} to exclude none
+ * @param included specific scopes to include or {@code null} to include all
+ * @param excluded specific scopes to exclude or {@code null} to exclude none
*/
public ScopeFilter( Collection<String> included, Collection<String> excluded )
{
Modified: maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/TransformableFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/TransformableFilter.java?rev=1685387&r1=1685386&r2=1685387&view=diff
==============================================================================
--- maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/TransformableFilter.java (original)
+++ maven/shared/trunk/maven-common-artifact-filters/src/main/java/org/apache/maven/shared/artifact/filter/resolve/TransformableFilter.java Sun Jun 14 11:36:28 2015
@@ -37,6 +37,7 @@ public interface TransformableFilter
* }
* </pre>
*
+ * @param <T> the interface of the tool specific filter
* @param transformer the tool specific transformer, may not be {@code null}
* @return the transformed value, never {@code null}
*/