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   =================== DO NOT EDIT THIS FILE ====================
19   Generated by Modello 2.4.0,
20   any modifications will be overwritten.
21   ==============================================================
22   */
23  
24  package org.apache.maven.archetype.metadata;
25  
26  /**
27   * Class ArchetypeDescriptor.
28   * 
29   * @version $Revision$ $Date$
30   */
31  @SuppressWarnings( "all" )
32  public class ArchetypeDescriptor
33      extends AbstractArchetypeDescriptor
34      implements java.io.Serializable
35  {
36  
37        //--------------------------/
38       //- Class/Member Variables -/
39      //--------------------------/
40  
41      /**
42       * Name of the Archetype, that will be displayed to the user
43       * when choosing an archetype.
44       */
45      private String name;
46  
47      /**
48       * Is this archetype representing a full Maven project or only
49       * parts?
50       */
51      private boolean partial = false;
52  
53      /**
54       * Field requiredProperties.
55       */
56      private java.util.List<RequiredProperty> requiredProperties;
57  
58      /**
59       * Field modelEncoding.
60       */
61      private String modelEncoding = "UTF-8";
62  
63  
64        //-----------/
65       //- Methods -/
66      //-----------/
67  
68      /**
69       * Method addRequiredProperty.
70       * 
71       * @param requiredProperty a requiredProperty object.
72       */
73      public void addRequiredProperty( RequiredProperty requiredProperty )
74      {
75          getRequiredProperties().add( requiredProperty );
76      } //-- void addRequiredProperty( RequiredProperty )
77  
78      /**
79       * Get the modelEncoding field.
80       * 
81       * @return String
82       */
83      public String getModelEncoding()
84      {
85          return this.modelEncoding;
86      } //-- String getModelEncoding()
87  
88      /**
89       * Get name of the Archetype, that will be displayed to the
90       * user when choosing an archetype.
91       * 
92       * @return String
93       */
94      public String getName()
95      {
96          return this.name;
97      } //-- String getName()
98  
99      /**
100      * Method getRequiredProperties.
101      * 
102      * @return List
103      */
104     public java.util.List<RequiredProperty> getRequiredProperties()
105     {
106         if ( this.requiredProperties == null )
107         {
108             this.requiredProperties = new java.util.ArrayList<RequiredProperty>();
109         }
110 
111         return this.requiredProperties;
112     } //-- java.util.List<RequiredProperty> getRequiredProperties()
113 
114     /**
115      * Get is this archetype representing a full Maven project or
116      * only parts?
117      * 
118      * @return boolean
119      */
120     public boolean isPartial()
121     {
122         return this.partial;
123     } //-- boolean isPartial()
124 
125     /**
126      * Method removeRequiredProperty.
127      * 
128      * @param requiredProperty a requiredProperty object.
129      */
130     public void removeRequiredProperty( RequiredProperty requiredProperty )
131     {
132         getRequiredProperties().remove( requiredProperty );
133     } //-- void removeRequiredProperty( RequiredProperty )
134 
135     /**
136      * Set the modelEncoding field.
137      * 
138      * @param modelEncoding a modelEncoding object.
139      */
140     public void setModelEncoding( String modelEncoding )
141     {
142         this.modelEncoding = modelEncoding;
143     } //-- void setModelEncoding( String )
144 
145     /**
146      * Set name of the Archetype, that will be displayed to the
147      * user when choosing an archetype.
148      * 
149      * @param name a name object.
150      */
151     public void setName( String name )
152     {
153         this.name = name;
154     } //-- void setName( String )
155 
156     /**
157      * Set is this archetype representing a full Maven project or
158      * only parts?
159      * 
160      * @param partial a partial object.
161      */
162     public void setPartial( boolean partial )
163     {
164         this.partial = partial;
165     } //-- void setPartial( boolean )
166 
167     /**
168      * Set list of required properties to generate a project from
169      * this archetype.
170      * 
171      * @param requiredProperties a requiredProperties object.
172      */
173     public void setRequiredProperties( java.util.List<RequiredProperty> requiredProperties )
174     {
175         this.requiredProperties = requiredProperties;
176     } //-- void setRequiredProperties( java.util.List )
177 
178 }