View Javadoc

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