View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2009-09-09 03:30:24,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.model;
9   
10  /**
11   * This elements describes all that pertains to distribution for a
12   * project. It is
13   *         primarily used for deployment of artifacts and the site
14   * produced by the build.
15   * 
16   * @version $Revision$ $Date$
17   */
18  public class DistributionManagement
19      implements java.io.Serializable
20  {
21  
22        //--------------------------/
23       //- Class/Member Variables -/
24      //--------------------------/
25  
26      /**
27       * Information needed to deploy the artifacts generated by the
28       * project to a
29       *             remote repository.
30       */
31      private DeploymentRepository repository;
32  
33      /**
34       * 
35       *             
36       *             Where to deploy snapshots of artifacts to. If
37       * not given, it defaults to the
38       *             <code>repository</code> element.
39       *             
40       *           
41       */
42      private DeploymentRepository snapshotRepository;
43  
44      /**
45       * Information needed for deploying the web site of the project.
46       */
47      private Site site;
48  
49      /**
50       * 
51       *             
52       *             The URL of the project's download page. If not
53       * given users will be
54       *             referred to the homepage given by
55       * <code>url</code>.
56       *             This is given to assist in locating artifacts
57       * that are not in the repository due to
58       *             licensing restrictions.
59       *             
60       *           
61       */
62      private String downloadUrl;
63  
64      /**
65       * Relocation information of the artifact if it has been moved
66       * to a new group ID
67       *             and/or artifact ID.
68       */
69      private Relocation relocation;
70  
71      /**
72       * 
73       *             
74       *             Gives the status of this artifact in the remote
75       * repository.
76       *             This must not be set in your local project, as
77       * it is updated by
78       *             tools placing it in the reposiory. Valid values
79       * are: <code>none</code> (default),
80       *             <code>converted</code> (repository manager
81       * converted this from an Maven 1 POM),
82       *             <code>partner</code>
83       *             (directly synced from a partner Maven 2
84       * repository), <code>deployed</code> (was deployed from a
85       * Maven 2
86       *             instance), <code>verified</code> (has been hand
87       * verified as correct and final).
88       *             
89       *           
90       */
91      private String status;
92  
93  
94        //-----------/
95       //- Methods -/
96      //-----------/
97  
98      /**
99       * Get the URL of the project's download page. If not given
100      * users will be
101      *             referred to the homepage given by
102      * <code>url</code>.
103      *             This is given to assist in locating artifacts
104      * that are not in the repository due to
105      *             licensing restrictions.
106      * 
107      * @return String
108      */
109     public String getDownloadUrl()
110     {
111         return this.downloadUrl;
112     } //-- String getDownloadUrl()
113 
114     /**
115      * Get relocation information of the artifact if it has been
116      * moved to a new group ID
117      *             and/or artifact ID.
118      * 
119      * @return Relocation
120      */
121     public Relocation getRelocation()
122     {
123         return this.relocation;
124     } //-- Relocation getRelocation()
125 
126     /**
127      * Get information needed to deploy the artifacts generated by
128      * the project to a
129      *             remote repository.
130      * 
131      * @return DeploymentRepository
132      */
133     public DeploymentRepository getRepository()
134     {
135         return this.repository;
136     } //-- DeploymentRepository getRepository()
137 
138     /**
139      * Get information needed for deploying the web site of the
140      * project.
141      * 
142      * @return Site
143      */
144     public Site getSite()
145     {
146         return this.site;
147     } //-- Site getSite()
148 
149     /**
150      * Get where to deploy snapshots of artifacts to. If not given,
151      * it defaults to the
152      *             <code>repository</code> element.
153      * 
154      * @return DeploymentRepository
155      */
156     public DeploymentRepository getSnapshotRepository()
157     {
158         return this.snapshotRepository;
159     } //-- DeploymentRepository getSnapshotRepository()
160 
161     /**
162      * Get gives the status of this artifact in the remote
163      * repository.
164      *             This must not be set in your local project, as
165      * it is updated by
166      *             tools placing it in the reposiory. Valid values
167      * are: <code>none</code> (default),
168      *             <code>converted</code> (repository manager
169      * converted this from an Maven 1 POM),
170      *             <code>partner</code>
171      *             (directly synced from a partner Maven 2
172      * repository), <code>deployed</code> (was deployed from a
173      * Maven 2
174      *             instance), <code>verified</code> (has been hand
175      * verified as correct and final).
176      * 
177      * @return String
178      */
179     public String getStatus()
180     {
181         return this.status;
182     } //-- String getStatus()
183 
184     /**
185      * Set the URL of the project's download page. If not given
186      * users will be
187      *             referred to the homepage given by
188      * <code>url</code>.
189      *             This is given to assist in locating artifacts
190      * that are not in the repository due to
191      *             licensing restrictions.
192      * 
193      * @param downloadUrl
194      */
195     public void setDownloadUrl( String downloadUrl )
196     {
197         this.downloadUrl = downloadUrl;
198     } //-- void setDownloadUrl( String )
199 
200     /**
201      * Set relocation information of the artifact if it has been
202      * moved to a new group ID
203      *             and/or artifact ID.
204      * 
205      * @param relocation
206      */
207     public void setRelocation( Relocation relocation )
208     {
209         this.relocation = relocation;
210     } //-- void setRelocation( Relocation )
211 
212     /**
213      * Set information needed to deploy the artifacts generated by
214      * the project to a
215      *             remote repository.
216      * 
217      * @param repository
218      */
219     public void setRepository( DeploymentRepository repository )
220     {
221         this.repository = repository;
222     } //-- void setRepository( DeploymentRepository )
223 
224     /**
225      * Set information needed for deploying the web site of the
226      * project.
227      * 
228      * @param site
229      */
230     public void setSite( Site site )
231     {
232         this.site = site;
233     } //-- void setSite( Site )
234 
235     /**
236      * Set where to deploy snapshots of artifacts to. If not given,
237      * it defaults to the
238      *             <code>repository</code> element.
239      * 
240      * @param snapshotRepository
241      */
242     public void setSnapshotRepository( DeploymentRepository snapshotRepository )
243     {
244         this.snapshotRepository = snapshotRepository;
245     } //-- void setSnapshotRepository( DeploymentRepository )
246 
247     /**
248      * Set gives the status of this artifact in the remote
249      * repository.
250      *             This must not be set in your local project, as
251      * it is updated by
252      *             tools placing it in the reposiory. Valid values
253      * are: <code>none</code> (default),
254      *             <code>converted</code> (repository manager
255      * converted this from an Maven 1 POM),
256      *             <code>partner</code>
257      *             (directly synced from a partner Maven 2
258      * repository), <code>deployed</code> (was deployed from a
259      * Maven 2
260      *             instance), <code>verified</code> (has been hand
261      * verified as correct and final).
262      * 
263      * @param status
264      */
265     public void setStatus( String status )
266     {
267         this.status = status;
268     } //-- void setStatus( String )
269 
270 
271 }