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