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