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