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