View Javadoc
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.ArchetypeGenerationRequest;
23  import org.apache.maven.archetype.exception.ArchetypeNotDefined;
24  import org.apache.maven.archetype.exception.ArchetypeSelectionFailure;
25  import org.apache.maven.archetype.exception.UnknownArchetype;
26  import org.apache.maven.archetype.exception.UnknownGroup;
27  import org.codehaus.plexus.components.interactivity.PrompterException;
28  
29  import java.io.IOException;
30  
31  /**
32   * Selection component to organize steps to choose an archetype.
33   */
34  //TODO: We should need any remote repositories here, we should simply be doing selection, any remote catalogs
35  //      should be validating correctness, and if it so happens we get a crap entry then the generation mechanism
36  //      should take care of reporting the error. The selector should not be downloading anything.
37  public interface ArchetypeSelector
38  {
39      String ROLE = ArchetypeSelector.class.getName();
40  
41      void selectArchetype( ArchetypeGenerationRequest request, Boolean interactiveMode, String catalogs )
42          throws ArchetypeNotDefined, UnknownArchetype, UnknownGroup, IOException, PrompterException,
43          ArchetypeSelectionFailure;
44  }