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