View Javadoc

1   package org.apache.maven.model.converter.relocators;
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.model.Model;
23  import org.apache.maven.model.converter.ConverterListener;
24  
25  import java.util.List;
26  
27  /**
28   * A plugin relocator handles a plugin that has changed its groupId and/or
29   * artifactId between the Maven 1 version and the Maven 2 version. It changes
30   * the appropriate values in the v4 pom.
31   *
32   * @author Dennis Lundberg
33   * @version $Id: PluginRelocator.java 661727 2008-05-30 14:21:49Z bentmann $
34   */
35  public interface PluginRelocator
36  {
37      String ROLE = PluginRelocator.class.getName();
38  
39      /**
40       * Relocate a plugin from one groupId/artifactId to another.
41       *
42       * @param v4Model The model where we look for the plugin
43       */
44      void relocate( Model v4Model );
45  
46      /**
47       * Add a listener for all messages sended by the relocator.
48       *
49       * @param listener The listener that will receive messages
50       */
51      void addListener( ConverterListener listener );
52  
53      /**
54       * Add a listeners list for all messages sended by the relocator.
55       *
56       * @param listeners The listeners list that will receive messages
57       */
58      void addListeners( List listeners );
59  }