View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.10.0,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.model;
7   
8   /**
9    * 
10   *         
11   *         The <code>&lt;scm&gt;</code> element contains
12   * informations required to the SCM
13   *         (Source Control Management) of the project.
14   *         
15   *       
16   * 
17   * @version $Revision$ $Date$
18   */
19  @SuppressWarnings( "all" )
20  public class Scm
21      implements java.io.Serializable, java.lang.Cloneable, org.apache.maven.model.InputLocationTracker
22  {
23  
24        //--------------------------/
25       //- Class/Member Variables -/
26      //--------------------------/
27  
28      /**
29       * 
30       *             
31       *             The source control management system URL
32       *             that describes the repository and how to connect
33       * to the
34       *             repository. For more information, see the
35       *             <a
36       * href="https://maven.apache.org/scm/scm-url-format.html">URL
37       * format</a>
38       *             and <a
39       * href="https://maven.apache.org/scm/scms-overview.html">list
40       * of supported SCMs</a>.
41       *             This connection is read-only.
42       *             <br><b>Default value is</b>: parent value [+
43       * path adjustment] + (artifactId or project.directory
44       * property), or just parent value if
45       *             scm's
46       * <code>child.scm.connection.inherit.append.path="false"</code>
47       *             
48       *           
49       */
50      private String connection;
51  
52      /**
53       * 
54       *             
55       *             Just like <code>connection</code>, but for
56       * developers, i.e. this scm connection
57       *             will not be read only.
58       *             <br><b>Default value is</b>: parent value [+
59       * path adjustment] + (artifactId or project.directory
60       * property), or just parent value if
61       *             scm's
62       * <code>child.scm.developerConnection.inherit.append.path="false"</code>
63       *             
64       *           
65       */
66      private String developerConnection;
67  
68      /**
69       * The tag of current code. By default, it's set to HEAD during
70       * development.
71       */
72      private String tag = "HEAD";
73  
74      /**
75       * 
76       *             
77       *             The URL to the project's browsable SCM
78       * repository, such as ViewVC or Fisheye.
79       *             <br><b>Default value is</b>: parent value [+
80       * path adjustment] + (artifactId or project.directory
81       * property), or just parent value if
82       *             scm's
83       * <code>child.scm.url.inherit.append.path="false"</code>
84       *             
85       *           
86       */
87      private String url;
88  
89      /**
90       * 
91       *             
92       *             When childs inherit from scm connection, append
93       * path or not? Note: While the type
94       *             of this field is <code>String</code> for
95       * technical reasons, the semantic type is actually
96       *             <code>Boolean</code>
97       *             <br><b>Default value is</b>: <code>true</code>
98       *             <br><b>Since</b>: Maven 3.6.1
99       *             
100      *           .
101      */
102     private String childScmConnectionInheritAppendPath;
103 
104     /**
105      * 
106      *             
107      *             When childs inherit from scm developer
108      * connection, append path or not? Note: While the type
109      *             of this field is <code>String</code> for
110      * technical reasons, the semantic type is actually
111      *             <code>Boolean</code>
112      *             <br><b>Default value is</b>: <code>true</code>
113      *             <br><b>Since</b>: Maven 3.6.1
114      *             
115      *           .
116      */
117     private String childScmDeveloperConnectionInheritAppendPath;
118 
119     /**
120      * 
121      *             
122      *             When childs inherit from scm url, append path or
123      * not? Note: While the type
124      *             of this field is <code>String</code> for
125      * technical reasons, the semantic type is actually
126      *             <code>Boolean</code>
127      *             <br><b>Default value is</b>: <code>true</code>
128      *             <br><b>Since</b>: Maven 3.6.1
129      *             
130      *           .
131      */
132     private String childScmUrlInheritAppendPath;
133 
134     /**
135      * Field locations.
136      */
137     private java.util.Map<Object, InputLocation> locations;
138 
139 
140       //-----------/
141      //- Methods -/
142     //-----------/
143 
144     /**
145      * Method clone.
146      * 
147      * @return Scm
148      */
149     public Scm clone()
150     {
151         try
152         {
153             Scm copy = (Scm) super.clone();
154 
155             if ( copy.locations != null )
156             {
157                 copy.locations = new java.util.LinkedHashMap( copy.locations );
158             }
159 
160             return copy;
161         }
162         catch ( java.lang.Exception ex )
163         {
164             throw (java.lang.RuntimeException) new java.lang.UnsupportedOperationException( getClass().getName()
165                 + " does not support clone()" ).initCause( ex );
166         }
167     } //-- Scm clone()
168 
169     /**
170      * Get when childs inherit from scm connection, append path or
171      * not? Note: While the type
172      *             of this field is <code>String</code> for
173      * technical reasons, the semantic type is actually
174      *             <code>Boolean</code>
175      *             <br><b>Default value is</b>: <code>true</code>
176      *             <br><b>Since</b>: Maven 3.6.1.
177      * 
178      * @return String
179      */
180     public String getChildScmConnectionInheritAppendPath()
181     {
182         return this.childScmConnectionInheritAppendPath;
183     } //-- String getChildScmConnectionInheritAppendPath()
184 
185     /**
186      * Get when childs inherit from scm developer connection,
187      * append path or not? Note: While the type
188      *             of this field is <code>String</code> for
189      * technical reasons, the semantic type is actually
190      *             <code>Boolean</code>
191      *             <br><b>Default value is</b>: <code>true</code>
192      *             <br><b>Since</b>: Maven 3.6.1.
193      * 
194      * @return String
195      */
196     public String getChildScmDeveloperConnectionInheritAppendPath()
197     {
198         return this.childScmDeveloperConnectionInheritAppendPath;
199     } //-- String getChildScmDeveloperConnectionInheritAppendPath()
200 
201     /**
202      * Get when childs inherit from scm url, append path or not?
203      * Note: While the type
204      *             of this field is <code>String</code> for
205      * technical reasons, the semantic type is actually
206      *             <code>Boolean</code>
207      *             <br><b>Default value is</b>: <code>true</code>
208      *             <br><b>Since</b>: Maven 3.6.1.
209      * 
210      * @return String
211      */
212     public String getChildScmUrlInheritAppendPath()
213     {
214         return this.childScmUrlInheritAppendPath;
215     } //-- String getChildScmUrlInheritAppendPath()
216 
217     /**
218      * Get the source control management system URL
219      *             that describes the repository and how to connect
220      * to the
221      *             repository. For more information, see the
222      *             <a
223      * href="https://maven.apache.org/scm/scm-url-format.html">URL
224      * format</a>
225      *             and <a
226      * href="https://maven.apache.org/scm/scms-overview.html">list
227      * of supported SCMs</a>.
228      *             This connection is read-only.
229      *             <br><b>Default value is</b>: parent value [+
230      * path adjustment] + (artifactId or project.directory
231      * property), or just parent value if
232      *             scm's
233      * <code>child.scm.connection.inherit.append.path="false"</code>
234      * 
235      * @return String
236      */
237     public String getConnection()
238     {
239         return this.connection;
240     } //-- String getConnection()
241 
242     /**
243      * Get just like <code>connection</code>, but for developers,
244      * i.e. this scm connection
245      *             will not be read only.
246      *             <br><b>Default value is</b>: parent value [+
247      * path adjustment] + (artifactId or project.directory
248      * property), or just parent value if
249      *             scm's
250      * <code>child.scm.developerConnection.inherit.append.path="false"</code>
251      * 
252      * @return String
253      */
254     public String getDeveloperConnection()
255     {
256         return this.developerConnection;
257     } //-- String getDeveloperConnection()
258 
259     /**
260      * 
261      * 
262      * @param key
263      * @return InputLocation
264      */
265     public InputLocation getLocation( Object key )
266     {
267         return ( locations != null ) ? locations.get( key ) : null;
268     } //-- InputLocation getLocation( Object )
269 
270     /**
271      * Get the tag of current code. By default, it's set to HEAD
272      * during development.
273      * 
274      * @return String
275      */
276     public String getTag()
277     {
278         return this.tag;
279     } //-- String getTag()
280 
281     /**
282      * Get the URL to the project's browsable SCM repository, such
283      * as ViewVC or Fisheye.
284      *             <br><b>Default value is</b>: parent value [+
285      * path adjustment] + (artifactId or project.directory
286      * property), or just parent value if
287      *             scm's
288      * <code>child.scm.url.inherit.append.path="false"</code>
289      * 
290      * @return String
291      */
292     public String getUrl()
293     {
294         return this.url;
295     } //-- String getUrl()
296 
297     /**
298      * Set when childs inherit from scm connection, append path or
299      * not? Note: While the type
300      *             of this field is <code>String</code> for
301      * technical reasons, the semantic type is actually
302      *             <code>Boolean</code>
303      *             <br><b>Default value is</b>: <code>true</code>
304      *             <br><b>Since</b>: Maven 3.6.1.
305      * 
306      * @param childScmConnectionInheritAppendPath
307      */
308     public void setChildScmConnectionInheritAppendPath( String childScmConnectionInheritAppendPath )
309     {
310         this.childScmConnectionInheritAppendPath = childScmConnectionInheritAppendPath;
311     } //-- void setChildScmConnectionInheritAppendPath( String )
312 
313     /**
314      * Set when childs inherit from scm developer connection,
315      * append path or not? Note: While the type
316      *             of this field is <code>String</code> for
317      * technical reasons, the semantic type is actually
318      *             <code>Boolean</code>
319      *             <br><b>Default value is</b>: <code>true</code>
320      *             <br><b>Since</b>: Maven 3.6.1.
321      * 
322      * @param childScmDeveloperConnectionInheritAppendPath
323      */
324     public void setChildScmDeveloperConnectionInheritAppendPath( String childScmDeveloperConnectionInheritAppendPath )
325     {
326         this.childScmDeveloperConnectionInheritAppendPath = childScmDeveloperConnectionInheritAppendPath;
327     } //-- void setChildScmDeveloperConnectionInheritAppendPath( String )
328 
329     /**
330      * Set when childs inherit from scm url, append path or not?
331      * Note: While the type
332      *             of this field is <code>String</code> for
333      * technical reasons, the semantic type is actually
334      *             <code>Boolean</code>
335      *             <br><b>Default value is</b>: <code>true</code>
336      *             <br><b>Since</b>: Maven 3.6.1.
337      * 
338      * @param childScmUrlInheritAppendPath
339      */
340     public void setChildScmUrlInheritAppendPath( String childScmUrlInheritAppendPath )
341     {
342         this.childScmUrlInheritAppendPath = childScmUrlInheritAppendPath;
343     } //-- void setChildScmUrlInheritAppendPath( String )
344 
345     /**
346      * Set the source control management system URL
347      *             that describes the repository and how to connect
348      * to the
349      *             repository. For more information, see the
350      *             <a
351      * href="https://maven.apache.org/scm/scm-url-format.html">URL
352      * format</a>
353      *             and <a
354      * href="https://maven.apache.org/scm/scms-overview.html">list
355      * of supported SCMs</a>.
356      *             This connection is read-only.
357      *             <br><b>Default value is</b>: parent value [+
358      * path adjustment] + (artifactId or project.directory
359      * property), or just parent value if
360      *             scm's
361      * <code>child.scm.connection.inherit.append.path="false"</code>
362      * 
363      * @param connection
364      */
365     public void setConnection( String connection )
366     {
367         this.connection = connection;
368     } //-- void setConnection( String )
369 
370     /**
371      * Set just like <code>connection</code>, but for developers,
372      * i.e. this scm connection
373      *             will not be read only.
374      *             <br><b>Default value is</b>: parent value [+
375      * path adjustment] + (artifactId or project.directory
376      * property), or just parent value if
377      *             scm's
378      * <code>child.scm.developerConnection.inherit.append.path="false"</code>
379      * 
380      * @param developerConnection
381      */
382     public void setDeveloperConnection( String developerConnection )
383     {
384         this.developerConnection = developerConnection;
385     } //-- void setDeveloperConnection( String )
386 
387     /**
388      * 
389      * 
390      * @param key
391      * @param location
392      */
393     public void setLocation( Object key, InputLocation location )
394     {
395         if ( location != null )
396         {
397             if ( this.locations == null )
398             {
399                 this.locations = new java.util.LinkedHashMap<Object, InputLocation>();
400             }
401             this.locations.put( key, location );
402         }
403     } //-- void setLocation( Object, InputLocation )
404 
405     /**
406      * Set the tag of current code. By default, it's set to HEAD
407      * during development.
408      * 
409      * @param tag
410      */
411     public void setTag( String tag )
412     {
413         this.tag = tag;
414     } //-- void setTag( String )
415 
416     /**
417      * Set the URL to the project's browsable SCM repository, such
418      * as ViewVC or Fisheye.
419      *             <br><b>Default value is</b>: parent value [+
420      * path adjustment] + (artifactId or project.directory
421      * property), or just parent value if
422      *             scm's
423      * <code>child.scm.url.inherit.append.path="false"</code>
424      * 
425      * @param url
426      */
427     public void setUrl( String url )
428     {
429         this.url = url;
430     } //-- void setUrl( String )
431 
432     
433             
434 
435     public boolean isChildScmConnectionInheritAppendPath()
436     {
437         return ( childScmConnectionInheritAppendPath != null ) ? Boolean.parseBoolean( childScmConnectionInheritAppendPath ) : true;
438     }
439 
440     public void setChildScmConnectionInheritAppendPath( boolean childScmConnectionInheritAppendPath )
441     {
442         this.childScmConnectionInheritAppendPath = String.valueOf( childScmConnectionInheritAppendPath );
443     }
444 
445     public boolean isChildScmDeveloperConnectionInheritAppendPath()
446     {
447         return ( childScmDeveloperConnectionInheritAppendPath != null ) ? Boolean.parseBoolean( childScmDeveloperConnectionInheritAppendPath ) : true;
448     }
449 
450     public void setChildScmDeveloperConnectionInheritAppendPath( boolean childScmDeveloperConnectionInheritAppendPath )
451     {
452         this.childScmDeveloperConnectionInheritAppendPath = String.valueOf( childScmDeveloperConnectionInheritAppendPath );
453     }
454 
455     public boolean isChildScmUrlInheritAppendPath()
456     {
457         return ( childScmUrlInheritAppendPath != null ) ? Boolean.parseBoolean( childScmUrlInheritAppendPath ) : true;
458     }
459 
460     public void setChildScmUrlInheritAppendPath( boolean childScmUrlInheritAppendPath )
461     {
462         this.childScmUrlInheritAppendPath = String.valueOf( childScmUrlInheritAppendPath );
463     }
464 
465             
466           
467 }