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.old;
20  
21  import java.io.File;
22  
23  import org.apache.maven.archetype.ArchetypeGenerationRequest;
24  import org.apache.maven.archetype.exception.InvalidPackaging;
25  import org.apache.maven.archetype.exception.UnknownArchetype;
26  
27  /**
28   * Create a Maven project from an old archetype.
29   *
30   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
31   * @version $Id$
32   */
33  public interface OldArchetype {
34      String ROLE = OldArchetype.class.getName();
35  
36      String ARCHETYPE_DESCRIPTOR = "META-INF/maven/archetype.xml";
37  
38      String ARCHETYPE_OLD_DESCRIPTOR = "META-INF/archetype.xml";
39  
40      String ARCHETYPE_RESOURCES = "archetype-resources";
41  
42      // TODO: delete this, it probably should be project.getFile instead
43      String ARCHETYPE_POM = "pom.xml";
44  
45      /**
46       * Download an archetype then create a project from it.
47       */
48      void createArchetype(ArchetypeGenerationRequest request)
49              throws UnknownArchetype, ArchetypeDescriptorException, ArchetypeTemplateProcessingException,
50                      InvalidPackaging;
51  
52      /**
53       * Create a project from an archetype file.
54       */
55      void createArchetype(ArchetypeGenerationRequest request, File archetypeFile)
56              throws ArchetypeDescriptorException, ArchetypeTemplateProcessingException, InvalidPackaging;
57  }