View Javadoc
1   package org.apache.maven.archetype.generator;
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.exception.ArchetypeGenerationFailure;
23  import org.apache.maven.archetype.exception.ArchetypeNotConfigured;
24  import org.apache.maven.archetype.exception.OutputFileExists;
25  import org.apache.maven.archetype.exception.PomFileExists;
26  import org.apache.maven.archetype.exception.ProjectDirectoryExists;
27  import org.apache.maven.archetype.exception.UnknownArchetype;
28  
29  import java.io.File;
30  import org.apache.maven.archetype.ArchetypeGenerationRequest;
31  
32  /**
33   * Generate a Maven project from an archetype.
34   *
35   * @author rafale
36   * @version $Id: FilesetArchetypeGenerator.html 942523 2015-03-06 00:20:33Z bimargulies $
37   */
38  public interface FilesetArchetypeGenerator
39  {
40      String ROLE = FilesetArchetypeGenerator.class.getName();
41  
42      /**
43       * Generate a project from an archetype file.
44       */
45      void generateArchetype( ArchetypeGenerationRequest request, File archetypeFile )
46          throws UnknownArchetype, ArchetypeNotConfigured, ProjectDirectoryExists, PomFileExists, OutputFileExists,
47          ArchetypeGenerationFailure;
48  }