View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugin.prefix;
20  
21  /**
22   * Resolves a plugin prefix.
23   *
24   * @since 3.0
25   */
26  public interface PluginPrefixResolver {
27  
28      /**
29       * Resolves the plugin prefix for the specified request.
30       *
31       * @param request The request that holds the details about the plugin and the repositories to consult, must not be
32       *            {@code null}.
33       * @return The result of the prefix resolution, never {@code null}.
34       * @throws NoPluginFoundForPrefixException If the plugin prefix could not be resolved.
35       */
36      PluginPrefixResult resolve(PluginPrefixRequest request) throws NoPluginFoundForPrefixException;
37  }