View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.shared.artifact.filter.resolve;
20  
21  import java.util.Collection;
22  import java.util.Collections;
23  
24  /**
25   * A simple filter to exclude artifacts based on either artifact id or group id and artifact id.
26   *
27   * @author Robert Scholte
28   * @since 3.0
29   * @see org.eclipse.aether.util.filter.ExclusionsDependencyFilter
30   */
31  public class ExclusionsFilter implements TransformableFilter {
32      private final Collection<String> excludes;
33  
34      /**
35       * The default constructor specifying a collection of keys which must be excluded.
36       *
37       * @param excludes the keys to exclude, may not be {@code null}
38       * @see org.apache.maven.artifact.Artifact#getDependencyConflictId()
39       */
40      public ExclusionsFilter(Collection<String> excludes) {
41          this.excludes = Collections.unmodifiableCollection(excludes);
42      }
43  
44      /**
45       * <p>Getter for the field <code>excludes</code>.</p>
46       *
47       * @return The list of excludes.
48       */
49      public final Collection<String> getExcludes() {
50          return excludes;
51      }
52  
53      /**
54       * {@inheritDoc}
55       *
56       * Transform this filter to a tool specific implementation
57       */
58      @Override
59      public <T> T transform(FilterTransformer<T> transformer) {
60          return transformer.transform(this);
61      }
62  }