View Javadoc
1   package org.apache.maven.lifecycle.internal;
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 org.apache.maven.project.MavenProject;
23  
24  import java.util.Arrays;
25  import java.util.Collection;
26  import java.util.Collections;
27  import java.util.TreeSet;
28  
29  /**
30   * Context of dependency artifacts for a particular project.
31   *
32   * @since 3.0
33   * @author Benjamin Bentmann
34   * @author Kristian Rosenvold (class extract only)
35   *         <p/>
36   *         NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
37   */
38  // TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
39  public class DependencyContext
40  {
41  
42      private static final Collection<?> UNRESOLVED = Arrays.asList();
43  
44      private final MavenProject project;
45  
46      private final Collection<String> scopesToCollectForCurrentProject;
47  
48      private final Collection<String> scopesToResolveForCurrentProject;
49  
50      private final Collection<String> scopesToCollectForAggregatedProjects;
51  
52      private final Collection<String> scopesToResolveForAggregatedProjects;
53  
54      private volatile Collection<?> lastDependencyArtifacts = UNRESOLVED;
55  
56      private volatile int lastDependencyArtifactCount = -1;
57  
58      public DependencyContext( MavenProject project, Collection<String> scopesToCollect,
59                                Collection<String> scopesToResolve )
60      {
61          this.project = project;
62          scopesToCollectForCurrentProject = scopesToCollect;
63          scopesToResolveForCurrentProject = scopesToResolve;
64          scopesToCollectForAggregatedProjects = Collections.synchronizedSet( new TreeSet<String>() );
65          scopesToResolveForAggregatedProjects = Collections.synchronizedSet( new TreeSet<String>() );
66      }
67  
68      public MavenProject getProject()
69      {
70          return project;
71      }
72  
73      public Collection<String> getScopesToCollectForCurrentProject()
74      {
75          return scopesToCollectForCurrentProject;
76      }
77  
78      public Collection<String> getScopesToResolveForCurrentProject()
79      {
80          return scopesToResolveForCurrentProject;
81      }
82  
83      public Collection<String> getScopesToCollectForAggregatedProjects()
84      {
85          return scopesToCollectForAggregatedProjects;
86      }
87  
88      public Collection<String> getScopesToResolveForAggregatedProjects()
89      {
90          return scopesToResolveForAggregatedProjects;
91      }
92  
93      public boolean isResolutionRequiredForCurrentProject()
94      {
95          return lastDependencyArtifacts != project.getDependencyArtifacts() || ( lastDependencyArtifacts != null
96              && lastDependencyArtifactCount != lastDependencyArtifacts.size() );
97      }
98  
99      public boolean isResolutionRequiredForAggregatedProjects( Collection<String> scopesToCollect,
100                                                               Collection<String> scopesToResolve )
101     {
102         boolean required =
103             scopesToCollectForAggregatedProjects.addAll( scopesToCollect )
104                 || scopesToResolveForAggregatedProjects.addAll( scopesToResolve );
105         return required;
106     }
107 
108     public void synchronizeWithProjectState()
109     {
110         lastDependencyArtifacts = project.getDependencyArtifacts();
111         lastDependencyArtifactCount = ( lastDependencyArtifacts != null ) ? lastDependencyArtifacts.size() : 0;
112     }
113 
114 }