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 java.util.Collection;
23  
24  /**
25   * A manager for plugin relocators.
26   *
27   * @author Dennis Lundberg
28   * @version $Id: PluginRelocatorManager.java 661727 2008-05-30 14:21:49Z bentmann $
29   */
30  public interface PluginRelocatorManager
31  {
32      String ROLE = PluginRelocatorManager.class.getName();
33  
34      /**
35       * Get a named plugin relocator.
36       *
37       * @param pluginRelocatorId The role-hint for the plexus component
38       * @return The named plugin relocator
39       * @throws NoSuchPluginRelocatorException If the named plugin relocator can not be found
40       */
41      PluginRelocator getPluginRelocator( String pluginRelocatorId )
42          throws NoSuchPluginRelocatorException;
43  
44      /**
45       * Get all available plugin relocators.
46       *
47       * @return A <code>Collection</code> of <code>PluginRelocator</code> objects
48       */
49      Collection getPluginRelocators();
50  }