Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ArchetypeSelectionQueryer |
|
| 1.0;1 |
1 | package org.apache.maven.archetype.ui.generation; | |
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 org.apache.maven.archetype.catalog.Archetype; | |
23 | import org.apache.maven.archetype.ui.ArchetypeDefinition; | |
24 | import org.codehaus.plexus.components.interactivity.PrompterException; | |
25 | ||
26 | import java.util.List; | |
27 | import java.util.Map; | |
28 | ||
29 | /** | |
30 | * User interaction component for archetype selection. | |
31 | * | |
32 | * @todo this interface is bound to its implementation through the prompter exception | |
33 | */ | |
34 | public interface ArchetypeSelectionQueryer | |
35 | { | |
36 | String ROLE = ArchetypeSelectionQueryer.class.getName(); | |
37 | ||
38 | public Archetype selectArchetype( Map<String, List<Archetype>> map ) | |
39 | throws PrompterException; | |
40 | ||
41 | boolean confirmSelection( ArchetypeDefinition archetypeDefinition ) | |
42 | throws PrompterException; | |
43 | ||
44 | /** | |
45 | * Select an archetype from the given map. | |
46 | * | |
47 | * @param archetypes the archetypes to choose from | |
48 | * @param defaultDefinition the default archetype, if present in the map | |
49 | * @return the selected archetype | |
50 | * @throws org.codehaus.plexus.components.interactivity.PrompterException if there is a problem in making a | |
51 | * selection | |
52 | */ | |
53 | Archetype selectArchetype( Map<String, List<Archetype>> archetypes, ArchetypeDefinition defaultDefinition ) | |
54 | throws PrompterException; | |
55 | } |