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.archetype.ui.generation;
20
21 import java.util.List;
22 import java.util.Map;
23
24 import org.apache.maven.archetype.catalog.Archetype;
25 import org.apache.maven.archetype.ui.ArchetypeDefinition;
26 import org.codehaus.plexus.components.interactivity.PrompterException;
27
28 /**
29 * <p>User interaction component for archetype selection.</p>
30 *
31 * TODO this interface is bound to its implementation through the prompter exception
32 */
33 public interface ArchetypeSelectionQueryer {
34
35 Archetype selectArchetype(Map<String, List<Archetype>> map) throws PrompterException;
36
37 /**
38 * Select an archetype from the given map.
39 *
40 * @param archetypes the archetypes to choose from
41 * @param defaultDefinition the default archetype, if present in the map
42 * @return the selected archetype
43 * @throws org.codehaus.plexus.components.interactivity.PrompterException if there is a problem in making a
44 * selection
45 */
46 Archetype selectArchetype(Map<String, List<Archetype>> archetypes, ArchetypeDefinition defaultDefinition)
47 throws PrompterException;
48 }