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
20 package org.apache.maven.archetype.ui;
21
22 import org.apache.maven.archetype.catalog.Archetype;
23 import org.apache.maven.archetype.common.ArchetypeDefinition;
24 import org.codehaus.plexus.components.interactivity.PrompterException;
25
26 import java.util.Map;
27
28 /**
29 * @todo this interface is bound to it's implementation through the prompter exception
30 */
31 public interface ArchetypeSelectionQueryer
32 {
33 String ROLE = ArchetypeSelectionQueryer.class.getName();
34
35 public Archetype selectArchetype( Map map )
36 throws PrompterException;
37
38 boolean confirmSelection( ArchetypeDefinition archetypeDefinition )
39 throws PrompterException;
40
41 // Archetype selectArchetype( List list )
42 // throws
43 // PrompterException;
44
45 // Archetype selectArtifact( List list )
46 // throws
47 // PrompterException;
48 //
49 // String selectGroup( List list )
50 // throws
51 // PrompterException;
52 //
53 // String selectVersion( List list )
54 // throws
55 // PrompterException;
56
57 /**
58 * Select an archetype from the given map.
59 *
60 * @param archetypes the archetypes to choose from
61 * @param defaultDefinition the default archetype, if present in the map
62 * @return the selected archetype
63 * @throws org.codehaus.plexus.components.interactivity.PrompterException if there is a problem in making a
64 * selection
65 */
66 Archetype selectArchetype( Map archetypes, ArchetypeDefinition defaultDefinition )
67 throws PrompterException;
68 }