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 include artifacts from a list of patterns. The artifact pattern syntax is of the form:
26 *
27 * <pre>
28 * [groupId]:[artifactId]:[extension]:[version]
29 * [groupId]:[artifactId]:[extension]:[classifier]:[version]
30 * </pre>
31 * <p>
32 * Where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
33 * segment is treated as an implicit wildcard. Version can be a range in case a {@code VersionScheme} is specified.
34 * </p>
35 * <p>
36 * For example, <code>org.apache.*</code> would match all artifacts whose group id started with
37 * <code>org.apache.</code> , and <code>:::*-SNAPSHOT</code> would match all snapshot artifacts.
38 * </p>
39 *
40 * @author Robert Scholte
41 * @since 3.0
42 * @see org.eclipse.aether.util.filter.PatternInclusionsDependencyFilter
43 * @see org.eclipse.aether.version.VersionScheme
44 */
45 public class PatternInclusionsFilter implements TransformableFilter {
46
47 private final Collection<String> includes;
48
49 /**
50 * The default constructor specifying a collection of pattern based keys which must be included.
51 *
52 * @param includes the includes
53 */
54 public PatternInclusionsFilter(Collection<String> includes) {
55 this.includes = Collections.unmodifiableCollection(includes);
56 }
57
58 /**
59 * Get the includes
60 *
61 * @return the includes,
62 */
63 public final Collection<String> getIncludes() {
64 return includes;
65 }
66
67 /**
68 * {@inheritDoc}
69 *
70 * Transform this filter to a tool specific implementation
71 */
72 @Override
73 public <T> T transform(FilterTransformer<T> transformer) {
74 return transformer.transform(this);
75 }
76 }