| package org.apache.maven.shared.artifact.filter.collection; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| import java.util.Arrays; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.apache.maven.artifact.Artifact; |
| import org.apache.maven.shared.utils.StringUtils; |
| |
| /** |
| * This is the common base class of ClassifierFilter and TypeFilter |
| * |
| * @author <a href="richardv@mxtelecom.com">Richard van der Hoff</a> |
| * @version $Id$ |
| */ |
| public abstract class AbstractArtifactFeatureFilter |
| extends AbstractArtifactsFilter |
| { |
| /** The list of types or classifiers to include */ |
| private List<String> includes; |
| |
| /** |
| * The list of types or classifiers to exclude (ignored if includes != null) |
| */ |
| private List<String> excludes; |
| |
| public AbstractArtifactFeatureFilter( String include, String exclude ) |
| { |
| setExcludes( exclude ); |
| setIncludes( include ); |
| } |
| |
| /** |
| * This function determines if filtering needs to be performed. Includes are processed before Excludes. |
| * |
| * @param artifacts the set of dependencies to filter. |
| * @return a Set of filtered dependencies. |
| */ |
| public Set<Artifact> filter( Set<Artifact> artifacts ) |
| { |
| Set<Artifact> results = artifacts; |
| |
| if ( this.includes != null && !this.includes.isEmpty() ) |
| { |
| results = filterIncludes( results, this.includes ); |
| } |
| |
| if ( this.excludes != null && !this.excludes.isEmpty() ) |
| { |
| results = filterExcludes( results, this.excludes ); |
| } |
| |
| return results; |
| } |
| |
| /** |
| * Processes the dependencies list and includes the dependencies that match a filter in the list. |
| * |
| * @param artifacts List of dependencies. |
| * @param theIncludes List of types or classifiers to include. |
| * @return a set of filtered artifacts. |
| */ |
| private Set<Artifact> filterIncludes( Set<Artifact> artifacts, List<String> theIncludes ) |
| { |
| Set<Artifact> result = new HashSet<Artifact>(); |
| |
| for ( String include : theIncludes ) |
| { |
| for ( Artifact artifact : artifacts ) |
| { |
| // if the classifier or type of the artifact |
| // matches the feature |
| // to include, add to the |
| // results |
| if ( compareFeatures( getArtifactFeature( artifact ), include ) ) |
| { |
| result.add( artifact ); |
| } |
| } |
| } |
| return result; |
| } |
| |
| /** |
| * Processes the dependencies list and excludes the dependencies that match a filter in the list. |
| * |
| * @param depends List of dependencies. |
| * @param excludes List of types or classifiers to exclude. |
| * @return a set of filtered artifacts. |
| */ |
| private Set<Artifact> filterExcludes( Set<Artifact> artifacts, List<String> theExcludes ) |
| { |
| Set<Artifact> result = new HashSet<Artifact>(); |
| |
| for ( Artifact artifact : artifacts ) |
| { |
| boolean exclude = false; |
| String artifactFeature = getArtifactFeature( artifact ); |
| |
| // look through all types or classifiers. If no |
| // matches are found |
| // then it can be added to the results. |
| for ( String excludeFeature : theExcludes ) |
| { |
| if ( compareFeatures( artifactFeature, excludeFeature ) ) |
| { |
| exclude = true; |
| break; |
| } |
| } |
| |
| if ( !exclude ) |
| { |
| result.add( artifact ); |
| } |
| } |
| |
| return result; |
| } |
| |
| /** |
| * Should return the type or classifier of the given artifact, so that we can filter it |
| * |
| * @param artifact artifact to return type or classifier of |
| * @return type or classifier |
| */ |
| protected abstract String getArtifactFeature( Artifact artifact ); |
| |
| public void setExcludes( String excludeString ) |
| { |
| if ( StringUtils.isNotEmpty( excludeString ) ) |
| { |
| this.excludes = Arrays.asList( StringUtils.split( excludeString, "," ) ); |
| } |
| } |
| |
| public void setIncludes( String includeString ) |
| { |
| if ( StringUtils.isNotEmpty( includeString ) ) |
| { |
| this.includes = Arrays.asList( StringUtils.split( includeString, "," ) ); |
| } |
| } |
| |
| /** |
| * @return Returns the excludes. |
| */ |
| public List<String> getExcludes() |
| { |
| return this.excludes; |
| } |
| |
| /** |
| * @return Returns the includes. |
| */ |
| public List<String> getIncludes() |
| { |
| return this.includes; |
| } |
| |
| /** |
| * Allows Feature comparison to be customized |
| * |
| * @param lhs String artifact's feature |
| * @param rhs String feature from exclude or include list |
| * @return boolean true if features match |
| */ |
| protected boolean compareFeatures( String lhs, String rhs ) |
| { |
| // If lhs is null, check that rhs is null. Otherwise check if strings are equal. |
| return ( lhs == null ? rhs == null : lhs.equals( rhs ) ); |
| } |
| } |