View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.8.1,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.model;
7   
8   /**
9    * Describes the licenses for this project. This is used to
10   * generate the license
11   *         page of the project's web site, as well as being taken
12   * into consideration in other reporting
13   *         and validation. The licenses listed for the project are
14   * that of the project itself, and not
15   *         of dependencies.
16   * 
17   * @version $Revision$ $Date$
18   */
19  @SuppressWarnings( "all" )
20  public class License
21      implements java.io.Serializable, java.lang.Cloneable, org.apache.maven.model.InputLocationTracker
22  {
23  
24        //--------------------------/
25       //- Class/Member Variables -/
26      //--------------------------/
27  
28      /**
29       * The full legal name of the license.
30       */
31      private String name;
32  
33      /**
34       * The official url for the license text.
35       */
36      private String url;
37  
38      /**
39       * 
40       *             
41       *             The primary method by which this project may be
42       * distributed.
43       *             <dl>
44       *               <dt>repo</dt>
45       *               <dd>may be downloaded from the Maven
46       * repository</dd>
47       *               <dt>manual</dt>
48       *               <dd>user must manually download and install
49       * the dependency.</dd>
50       *             </dl>
51       *             
52       *           
53       */
54      private String distribution;
55  
56      /**
57       * Addendum information pertaining to this license.
58       */
59      private String comments;
60  
61      /**
62       * Field locations.
63       */
64      private java.util.Map<Object, InputLocation> locations;
65  
66  
67        //-----------/
68       //- Methods -/
69      //-----------/
70  
71      /**
72       * Method clone.
73       * 
74       * @return License
75       */
76      public License clone()
77      {
78          try
79          {
80              License copy = (License) super.clone();
81  
82              if ( copy.locations != null )
83              {
84                  copy.locations = new java.util.LinkedHashMap( copy.locations );
85              }
86  
87              return copy;
88          }
89          catch ( java.lang.Exception ex )
90          {
91              throw (java.lang.RuntimeException) new java.lang.UnsupportedOperationException( getClass().getName()
92                  + " does not support clone()" ).initCause( ex );
93          }
94      } //-- License clone()
95  
96      /**
97       * Get addendum information pertaining to this license.
98       * 
99       * @return String
100      */
101     public String getComments()
102     {
103         return this.comments;
104     } //-- String getComments()
105 
106     /**
107      * Get the primary method by which this project may be
108      * distributed.
109      *             <dl>
110      *               <dt>repo</dt>
111      *               <dd>may be downloaded from the Maven
112      * repository</dd>
113      *               <dt>manual</dt>
114      *               <dd>user must manually download and install
115      * the dependency.</dd>
116      *             </dl>
117      * 
118      * @return String
119      */
120     public String getDistribution()
121     {
122         return this.distribution;
123     } //-- String getDistribution()
124 
125     /**
126      * 
127      * 
128      * @param key
129      * @return InputLocation
130      */
131     public InputLocation getLocation( Object key )
132     {
133         return ( locations != null ) ? locations.get( key ) : null;
134     } //-- InputLocation getLocation( Object )
135 
136     /**
137      * Get the full legal name of the license.
138      * 
139      * @return String
140      */
141     public String getName()
142     {
143         return this.name;
144     } //-- String getName()
145 
146     /**
147      * Get the official url for the license text.
148      * 
149      * @return String
150      */
151     public String getUrl()
152     {
153         return this.url;
154     } //-- String getUrl()
155 
156     /**
157      * Set addendum information pertaining to this license.
158      * 
159      * @param comments
160      */
161     public void setComments( String comments )
162     {
163         this.comments = comments;
164     } //-- void setComments( String )
165 
166     /**
167      * Set the primary method by which this project may be
168      * distributed.
169      *             <dl>
170      *               <dt>repo</dt>
171      *               <dd>may be downloaded from the Maven
172      * repository</dd>
173      *               <dt>manual</dt>
174      *               <dd>user must manually download and install
175      * the dependency.</dd>
176      *             </dl>
177      * 
178      * @param distribution
179      */
180     public void setDistribution( String distribution )
181     {
182         this.distribution = distribution;
183     } //-- void setDistribution( String )
184 
185     /**
186      * 
187      * 
188      * @param key
189      * @param location
190      */
191     public void setLocation( Object key, InputLocation location )
192     {
193         if ( location != null )
194         {
195             if ( this.locations == null )
196             {
197                 this.locations = new java.util.LinkedHashMap<Object, InputLocation>();
198             }
199             this.locations.put( key, location );
200         }
201     } //-- void setLocation( Object, InputLocation )
202 
203     /**
204      * Set the full legal name of the license.
205      * 
206      * @param name
207      */
208     public void setName( String name )
209     {
210         this.name = name;
211     } //-- void setName( String )
212 
213     /**
214      * Set the official url for the license text.
215      * 
216      * @param url
217      */
218     public void setUrl( String url )
219     {
220         this.url = url;
221     } //-- void setUrl( String )
222 
223 }