View Javadoc
1   package org.apache.maven.archetype.ui.creation;
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.ui.ArchetypeConfiguration;
23  import org.codehaus.plexus.components.interactivity.PrompterException;
24  
25  /**
26   * <p>User interaction component to query informations necessary for an archetype creation from a project.</p>
27   * 
28   * TODO this interface is bound to its implementation through the prompter exception
29   */
30  public interface ArchetypeCreationQueryer
31  {
32      String ROLE = ArchetypeCreationQueryer.class.getName();
33  
34      /**
35       */
36      String getArchetypeArtifactId( String defaultValue )
37          throws PrompterException;
38  
39      /**
40       */
41      String getArchetypeGroupId( String defaultValue )
42          throws PrompterException;
43  
44      /**
45       */
46      String getArchetypeVersion( String defaultValue )
47          throws PrompterException;
48  
49      /**
50       */
51      String getArtifactId( String defaultValue )
52          throws PrompterException;
53  
54      /**
55       */
56      boolean askAddAnotherProperty()
57          throws PrompterException;
58  
59      /**
60       */
61      String askNewPropertyKey()
62          throws PrompterException;
63  
64      /**
65       */
66      String askReplacementValue( String propertyKey, String defaultValue )
67          throws PrompterException;
68  
69      /**
70       */
71      boolean confirmConfiguration( ArchetypeConfiguration archetypeConfiguration )
72          throws PrompterException;
73  
74      /**
75       */
76      String getGroupId( String defaultValue )
77          throws PrompterException;
78  
79      /**
80       */
81      String getPackage( String defaultValue )
82          throws PrompterException;
83  
84      /**
85       */
86      String getVersion( String defaultValue )
87          throws PrompterException;
88  }