View Javadoc
1   package org.apache.maven.plugin.prefix;
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  /**
23   * Resolves a plugin prefix.
24   * 
25   * @since 3.0
26   * @author Benjamin Bentmann
27   */
28  public interface PluginPrefixResolver
29  {
30  
31      /**
32       * Resolves the plugin prefix for the specified request.
33       * 
34       * @param request The request that holds the details about the plugin and the repositories to consult, must not be
35       *            {@code null}.
36       * @return The result of the prefix resolution, never {@code null}.
37       * @throws NoPluginFoundForPrefixException If the plugin prefix could not be resolved.
38       */
39      PluginPrefixResult resolve( PluginPrefixRequest request )
40          throws NoPluginFoundForPrefixException;
41  
42  }