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   * Describes the licenses for this project. This is used to
12   * generate the license
13   *         page of the project's web site, as well as being taken
14   * into consideration in other reporting
15   *         and validation. The licenses listed for the project are
16   * that of the project itself, and not
17   *         of dependencies.
18   * 
19   * @version $Revision$ $Date$
20   */
21  public class License
22      implements java.io.Serializable
23  {
24  
25        //--------------------------/
26       //- Class/Member Variables -/
27      //--------------------------/
28  
29      /**
30       * The full legal name of the license.
31       */
32      private String name;
33  
34      /**
35       * The official url for the license text.
36       */
37      private String url;
38  
39      /**
40       * 
41       *             
42       *             The primary method by which this project may be
43       * distributed.
44       *             <dl>
45       *               <dt>repo</dt>
46       *               <dd>may be downloaded from the Maven
47       * repository</dd>
48       *               <dt>manual</dt>
49       *               <dd>user must manually download and install
50       * the dependency.</dd>
51       *             </dl>
52       *             
53       *           
54       */
55      private String distribution;
56  
57      /**
58       * Addendum information pertaining to this license.
59       */
60      private String comments;
61  
62  
63        //-----------/
64       //- Methods -/
65      //-----------/
66  
67      /**
68       * Get addendum information pertaining to this license.
69       * 
70       * @return String
71       */
72      public String getComments()
73      {
74          return this.comments;
75      } //-- String getComments()
76  
77      /**
78       * Get the primary method by which this project may be
79       * distributed.
80       *             <dl>
81       *               <dt>repo</dt>
82       *               <dd>may be downloaded from the Maven
83       * repository</dd>
84       *               <dt>manual</dt>
85       *               <dd>user must manually download and install
86       * the dependency.</dd>
87       *             </dl>
88       * 
89       * @return String
90       */
91      public String getDistribution()
92      {
93          return this.distribution;
94      } //-- String getDistribution()
95  
96      /**
97       * Get the full legal name of the license.
98       * 
99       * @return String
100      */
101     public String getName()
102     {
103         return this.name;
104     } //-- String getName()
105 
106     /**
107      * Get the official url for the license text.
108      * 
109      * @return String
110      */
111     public String getUrl()
112     {
113         return this.url;
114     } //-- String getUrl()
115 
116     /**
117      * Set addendum information pertaining to this license.
118      * 
119      * @param comments
120      */
121     public void setComments( String comments )
122     {
123         this.comments = comments;
124     } //-- void setComments( String )
125 
126     /**
127      * Set the primary method by which this project may be
128      * distributed.
129      *             <dl>
130      *               <dt>repo</dt>
131      *               <dd>may be downloaded from the Maven
132      * repository</dd>
133      *               <dt>manual</dt>
134      *               <dd>user must manually download and install
135      * the dependency.</dd>
136      *             </dl>
137      * 
138      * @param distribution
139      */
140     public void setDistribution( String distribution )
141     {
142         this.distribution = distribution;
143     } //-- void setDistribution( String )
144 
145     /**
146      * Set the full legal name of the license.
147      * 
148      * @param name
149      */
150     public void setName( String name )
151     {
152         this.name = name;
153     } //-- void setName( String )
154 
155     /**
156      * Set the official url for the license text.
157      * 
158      * @param url
159      */
160     public void setUrl( String url )
161     {
162         this.url = url;
163     } //-- void setUrl( String )
164 
165 
166 }