View Javadoc

1   package org.apache.maven.plugin.prefix;
2   
3   import org.sonatype.aether.repository.ArtifactRepository;
4   
5   /*
6    * Licensed to the Apache Software Foundation (ASF) under one
7    * or more contributor license agreements.  See the NOTICE file
8    * distributed with this work for additional information
9    * regarding copyright ownership.  The ASF licenses this file
10   * to you under the Apache License, Version 2.0 (the
11   * "License"); you may not use this file except in compliance
12   * with the License.  You may obtain a copy of the License at
13   *
14   *   http://www.apache.org/licenses/LICENSE-2.0
15   *
16   * Unless required by applicable law or agreed to in writing,
17   * software distributed under the License is distributed on an
18   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19   * KIND, either express or implied.  See the License for the
20   * specific language governing permissions and limitations
21   * under the License.
22   */
23  
24  /**
25   * Describes the result of a plugin prefix resolution request.
26   * 
27   * @since 3.0
28   * @author Benjamin Bentmann
29   */
30  public interface PluginPrefixResult
31  {
32  
33      /**
34       * The resolved group id for the plugin.
35       * 
36       * @return The resolved group id for the plugin, never {@code null}.
37       */
38      String getGroupId();
39  
40      /**
41       * The resolved artifact id for the plugin.
42       * 
43       * @return The resolved artifact id for the plugin, never {@code null}.
44       */
45      String getArtifactId();
46  
47      /**
48       * The repository from which the plugin prefix was resolved.
49       * 
50       * @return The repository from which the plugin prefix was resolved or {@code null} if the prefix was resolved from
51       *         the supplied POM.
52       */
53      ArtifactRepository getRepository();
54  
55  }