View Javadoc
1   package org.apache.maven.plugins.dependency.utils.filters;
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.LinkedHashSet;
23  import java.util.Set;
24  
25  import org.apache.maven.artifact.Artifact;
26  import org.apache.maven.plugin.MojoExecutionException;
27  import org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem;
28  import org.apache.maven.plugins.dependency.utils.markers.MarkerHandler;
29  import org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter;
30  import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
31  
32  /**
33   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
34   */
35  public class MarkerFileFilter
36      extends AbstractArtifactsFilter
37      implements ArtifactItemFilter
38  {
39  
40      private boolean overWriteReleases;
41  
42      private boolean overWriteSnapshots;
43  
44      private boolean overWriteIfNewer;
45  
46      /**
47       * The handler.
48       */
49      protected final MarkerHandler handler;
50  
51      /**
52       * @param overWriteReleases true/false.
53       * @param overWriteSnapshots true/false.
54       * @param overWriteIfNewer true/false.
55       * @param handler {@link MarkerHandler}
56       */
57      public MarkerFileFilter( boolean overWriteReleases, boolean overWriteSnapshots, boolean overWriteIfNewer,
58                               MarkerHandler handler )
59      {
60          this.overWriteReleases = overWriteReleases;
61          this.overWriteSnapshots = overWriteSnapshots;
62          this.overWriteIfNewer = overWriteIfNewer;
63          this.handler = handler;
64      }
65  
66      /*
67       * (non-Javadoc)
68       * @see org.apache.mojo.dependency.utils.filters.ArtifactsFilter#filter(java.util.Set,
69       * org.apache.maven.plugin.logging.Log)
70       */
71      @Override
72      public Set<Artifact> filter( Set<Artifact> artifacts )
73          throws ArtifactFilterException
74      {
75          Set<Artifact> result = new LinkedHashSet<>();
76  
77          for ( Artifact artifact : artifacts )
78          {
79              if ( isArtifactIncluded( new ArtifactItem( artifact ) ) )
80              {
81                  result.add( artifact );
82              }
83          }
84  
85          return result;
86      }
87  
88      @Override
89      public boolean isArtifactIncluded( ArtifactItem item )
90          throws ArtifactFilterException
91      {
92          Artifact artifact = item.getArtifact();
93  
94          boolean overWrite = ( artifact.isSnapshot() && this.overWriteSnapshots )
95              || ( !artifact.isSnapshot() && this.overWriteReleases );
96  
97          handler.setArtifact( artifact );
98  
99          try
100         {
101             return overWrite || !handler.isMarkerSet() || ( overWriteIfNewer && handler.isMarkerOlder( artifact ) );
102         }
103         catch ( MojoExecutionException e )
104         {
105             throw new ArtifactFilterException( e.getMessage(), e );
106         }
107     }
108 
109     /**
110      * @return Returns the overWriteReleases.
111      */
112     public boolean isOverWriteReleases()
113     {
114         return this.overWriteReleases;
115     }
116 
117     /**
118      * @param overWriteReleases The overWriteReleases to set.
119      */
120     public void setOverWriteReleases( boolean overWriteReleases )
121     {
122         this.overWriteReleases = overWriteReleases;
123     }
124 
125     /**
126      * @return Returns the overWriteSnapshots.
127      */
128     public boolean isOverWriteSnapshots()
129     {
130         return this.overWriteSnapshots;
131     }
132 
133     /**
134      * @param overWriteSnapshots The overWriteSnapshots to set.
135      */
136     public void setOverWriteSnapshots( boolean overWriteSnapshots )
137     {
138         this.overWriteSnapshots = overWriteSnapshots;
139     }
140 
141     /**
142      * @return Returns the overWriteIfNewer.
143      */
144     public boolean isOverWriteIfNewer()
145     {
146         return this.overWriteIfNewer;
147     }
148 
149     /**
150      * @param overWriteIfNewer The overWriteIfNewer to set.
151      */
152     public void setOverWriteIfNewer( boolean overWriteIfNewer )
153     {
154         this.overWriteIfNewer = overWriteIfNewer;
155     }
156 }