View Javadoc
1   package org.apache.maven.shared.artifact.filter.collection;
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  /**
23   * 
24   */
25  
26  import java.util.Set;
27  
28  import org.apache.maven.artifact.Artifact;
29  
30  /**
31   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
32   * @version $Id: ArtifactsFilter.java 1716978 2015-11-28 14:47:04Z khmarbaise $
33   */
34  public interface ArtifactsFilter
35  {
36      /**
37       * @param artifacts {@link Artifact}
38       * @return Set of artifacts.
39       * @throws ArtifactFilterException in case of a failure.
40       */
41      Set<Artifact> filter( Set<Artifact> artifacts )
42          throws ArtifactFilterException;
43  
44      /**
45       * @param artifact {@link Artifact}
46       * @return {@code true} if artifact is included {@code false} otherwise.
47       * @throws ArtifactFilterException in case of a failure.
48       */
49      boolean isArtifactIncluded( Artifact artifact )
50          throws ArtifactFilterException;
51  }