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