001package org.apache.maven.plugin.prefix;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Resolves a plugin prefix.
024 *
025 * @since 3.0
026 * @author Benjamin Bentmann
027 */
028public interface PluginPrefixResolver
029{
030
031    /**
032     * Resolves the plugin prefix for the specified request.
033     *
034     * @param request The request that holds the details about the plugin and the repositories to consult, must not be
035     *            {@code null}.
036     * @return The result of the prefix resolution, never {@code null}.
037     * @throws NoPluginFoundForPrefixException If the plugin prefix could not be resolved.
038     */
039    PluginPrefixResult resolve( PluginPrefixRequest request )
040        throws NoPluginFoundForPrefixException;
041
042}