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