View Javadoc
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.io.IOException;
22  import java.util.Properties;
23  
24  import org.apache.maven.archetype.ArchetypeGenerationRequest;
25  import org.apache.maven.archetype.exception.ArchetypeGenerationConfigurationFailure;
26  import org.apache.maven.archetype.exception.ArchetypeNotConfigured;
27  import org.apache.maven.archetype.exception.ArchetypeNotDefined;
28  import org.apache.maven.archetype.exception.UnknownArchetype;
29  import org.codehaus.plexus.components.interactivity.PrompterException;
30  
31  /**
32   * Configurator component to organize steps for project generation from an archetype.
33   */
34  public interface ArchetypeGenerationConfigurator {
35      String ROLE = ArchetypeGenerationConfigurator.class.getName();
36  
37      void configureArchetype(
38              ArchetypeGenerationRequest request, Boolean interactiveMode, Properties commandLineProperties)
39              throws ArchetypeNotDefined, UnknownArchetype, ArchetypeNotConfigured, IOException, PrompterException,
40                      ArchetypeGenerationConfigurationFailure;
41  }