View Javadoc
1   package org.apache.maven.lifecycle;
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.codehaus.plexus.component.annotations.Component;
23  import org.codehaus.plexus.component.annotations.Requirement;
24  import org.codehaus.plexus.logging.Logger;
25  import org.codehaus.plexus.util.StringUtils;
26  
27  import com.google.common.base.Preconditions;
28  
29  import java.util.ArrayList;
30  import java.util.Arrays;
31  import java.util.HashMap;
32  import java.util.LinkedHashMap;
33  import java.util.LinkedHashSet;
34  import java.util.List;
35  import java.util.Map;
36  import java.util.Set;
37  
38  /**
39   * @since 3.0
40   * @author Jason van Zyl
41   * @author Kristian Rosenvold
42   */
43  // TODO: The configuration for the lifecycle needs to be externalized so that I can use the annotations properly for the
44  // wiring and reference and external source for the lifecycle configuration.
45  @Component( role = DefaultLifecycles.class )
46  public class DefaultLifecycles
47  {
48      public static final String[] STANDARD_LIFECYCLES = { "default", "clean", "site" };
49  
50      // @Configuration(source="org/apache/maven/lifecycle/lifecycles.xml")
51  
52      @Requirement( role = Lifecycle.class )
53      private Map<String, Lifecycle> lifecycles;
54  
55      @Requirement
56      private Logger logger;
57  
58      public DefaultLifecycles()
59      {
60      }
61  
62      public DefaultLifecycles( Map<String, Lifecycle> lifecycles, Logger logger )
63      {
64          this.lifecycles = new LinkedHashMap<>();
65          this.logger = logger;
66          this.lifecycles = lifecycles;
67      }
68  
69      public Lifecycle get( String key )
70      {
71          return getPhaseToLifecycleMap().get( key );
72      }
73  
74      /**
75       * We use this to map all phases to the lifecycle that contains it. This is used so that a user can specify the
76       * phase they want to execute and we can easily determine what lifecycle we need to run.
77       *
78       * @return A map of lifecycles, indexed on id
79       */
80      public Map<String, Lifecycle> getPhaseToLifecycleMap()
81      {
82          // If people are going to make their own lifecycles then we need to tell people how to namespace them correctly
83          // so that they don't interfere with internally defined lifecycles.
84  
85          HashMap<String, Lifecycle> phaseToLifecycleMap = new HashMap<>();
86  
87          for ( Lifecycle lifecycle : getLifeCycles() )
88          {
89              if ( logger.isDebugEnabled() )
90              {
91                  logger.debug( "Lifecycle " + lifecycle );
92              }
93  
94              for ( String phase : lifecycle.getPhases() )
95              {
96                  // The first definition wins.
97                  if ( !phaseToLifecycleMap.containsKey( phase ) )
98                  {
99                      phaseToLifecycleMap.put( phase, lifecycle );
100                 }
101                 else
102                 {
103                     Lifecycle original = phaseToLifecycleMap.get( phase );
104                     logger.warn( "Duplicated lifecycle phase " + phase + ". Defined in " + original.getId()
105                         + " but also in " + lifecycle.getId() );
106                 }
107             }
108         }
109 
110         return phaseToLifecycleMap;
111     }
112 
113     public List<Lifecycle> getLifeCycles()
114     {
115         // ensure canonical order of standard lifecycles
116         Map<String, Lifecycle> lifecycles = new LinkedHashMap<>( this.lifecycles );
117 
118         LinkedHashSet<String> lifecycleNames = new LinkedHashSet<>( Arrays.asList( STANDARD_LIFECYCLES ) );
119         lifecycleNames.addAll( lifecycles.keySet() );
120 
121         ArrayList<Lifecycle> result = new ArrayList<>();
122         for ( String name : lifecycleNames )
123         {
124             Lifecycle lifecycle = lifecycles.get( name );
125             Preconditions.checkNotNull( "A lifecycle must have an id.", lifecycle.getId() );
126             result.add( lifecycle );
127         }
128 
129         return result;
130     }
131 
132     public String getLifecyclePhaseList()
133     {
134         Set<String> phases = new LinkedHashSet<>();
135 
136         for ( Lifecycle lifecycle : getLifeCycles() )
137         {
138             phases.addAll( lifecycle.getPhases() );
139         }
140 
141         return StringUtils.join( phases.iterator(), ", " );
142     }
143 
144 }