View Javadoc

1   package org.apache.maven;
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.execution.MavenSession;
23  
24  /**
25   * Allows core extensions to participate in build lifecycle.
26   *
27   * All callback methods (will) follow beforeXXX/afterXXX naming pattern to
28   * indicate at what lifecycle point it is being called.
29   *
30   */
31  public abstract class AbstractMavenLifecycleParticipant
32  {
33  
34      /**
35       * Invoked after all MavenProject instances have been created.
36       *
37       * This callback is intended to allow extensions to manipulate MavenProjects
38       * before they are sorted and actual build execution starts.
39       */
40      public void afterProjectsRead( MavenSession session )
41          throws MavenExecutionException
42      {
43          // do nothing
44      }
45  
46      /**
47       * Invoked after MavenSession instance has been created.
48       *
49       * This callback is intended to allow extensions to inject execution properties,
50       * activate profiles and perform similar tasks that affect MavenProject
51       * instance construction.
52       */
53      // TODO: This is too early for build extensions, so maybe just remove it?
54      public void afterSessionStart( MavenSession session )
55          throws MavenExecutionException
56      {
57          // do nothing
58      }
59  
60  }