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