View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 2.1.2,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.plugins.javadoc.options;
7   
8   /**
9    * Root class to contain all javadoc configuration options for
10   * inclusion in javadoc bundle archives.
11   * 
12   * @version $Revision$ $Date$
13   */
14  @SuppressWarnings( "all" )
15  public class JavadocOptions
16      implements java.io.Serializable
17  {
18  
19        //--------------------------/
20       //- Class/Member Variables -/
21      //--------------------------/
22  
23      /**
24       * Field groups.
25       */
26      private java.util.List<Group> groups;
27  
28      /**
29       * Field tags.
30       */
31      private java.util.List<Tag> tags;
32  
33      /**
34       * Field docletArtifacts.
35       */
36      private java.util.List<DocletArtifact> docletArtifacts;
37  
38      /**
39       * Field taglets.
40       */
41      private java.util.List<Taglet> taglets;
42  
43      /**
44       * Field offlineLinks.
45       */
46      private java.util.List<OfflineLink> offlineLinks;
47  
48      /**
49       * Field tagletArtifacts.
50       */
51      private java.util.List<TagletArtifact> tagletArtifacts;
52  
53      /**
54       * Field resourcesArtifacts.
55       */
56      private java.util.List<ResourcesArtifact> resourcesArtifacts;
57  
58      /**
59       * Field bootclasspathArtifacts.
60       */
61      private java.util.List<BootclasspathArtifact> bootclasspathArtifacts;
62  
63      /**
64       * Field links.
65       */
66      private java.util.List<String> links;
67  
68      /**
69       * Field excludePackageNames.
70       */
71      private java.util.List<String> excludePackageNames;
72  
73      /**
74       * Enables deep copying of the '&#42;&#42;/doc-files'
75       * directories and the specific 'resources' directory.
76       */
77      private boolean docfilesSubdirsUsed = false;
78  
79      /**
80       * List of exclusion patterns separated by ':' for deep copying
81       * of the '&#42;&#42;/doc-files' directories.
82       */
83      private String excludedDocfilesSubdirs;
84  
85      /**
86       * 
87       *             Path relative to project basedir where javadoc
88       * resources were located. 
89       *             This is mainly useful in multimodule builds
90       * where the reactor is still populated.
91       *           
92       */
93      private String javadocResourcesDirectory;
94  
95      /**
96       * Field modelEncoding.
97       */
98      private String modelEncoding = "UTF-8";
99  
100 
101       //-----------/
102      //- Methods -/
103     //-----------/
104 
105     /**
106      * Method addBootclasspathArtifact.
107      * 
108      * @param bootclasspathArtifact a bootclasspathArtifact object.
109      */
110     public void addBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
111     {
112         getBootclasspathArtifacts().add( bootclasspathArtifact );
113     } //-- void addBootclasspathArtifact( BootclasspathArtifact )
114 
115     /**
116      * Method addDocletArtifact.
117      * 
118      * @param docletArtifact a docletArtifact object.
119      */
120     public void addDocletArtifact( DocletArtifact docletArtifact )
121     {
122         getDocletArtifacts().add( docletArtifact );
123     } //-- void addDocletArtifact( DocletArtifact )
124 
125     /**
126      * Method addExcludePackageName.
127      * 
128      * @param string a string object.
129      */
130     public void addExcludePackageName( String string )
131     {
132         getExcludePackageNames().add( string );
133     } //-- void addExcludePackageName( String )
134 
135     /**
136      * Method addGroup.
137      * 
138      * @param group a group object.
139      */
140     public void addGroup( Group group )
141     {
142         getGroups().add( group );
143     } //-- void addGroup( Group )
144 
145     /**
146      * Method addLink.
147      * 
148      * @param string a string object.
149      */
150     public void addLink( String string )
151     {
152         getLinks().add( string );
153     } //-- void addLink( String )
154 
155     /**
156      * Method addOfflineLink.
157      * 
158      * @param offlineLink a offlineLink object.
159      */
160     public void addOfflineLink( OfflineLink offlineLink )
161     {
162         getOfflineLinks().add( offlineLink );
163     } //-- void addOfflineLink( OfflineLink )
164 
165     /**
166      * Method addResourcesArtifact.
167      * 
168      * @param resourcesArtifact a resourcesArtifact object.
169      */
170     public void addResourcesArtifact( ResourcesArtifact resourcesArtifact )
171     {
172         getResourcesArtifacts().add( resourcesArtifact );
173     } //-- void addResourcesArtifact( ResourcesArtifact )
174 
175     /**
176      * Method addTag.
177      * 
178      * @param tag a tag object.
179      */
180     public void addTag( Tag tag )
181     {
182         getTags().add( tag );
183     } //-- void addTag( Tag )
184 
185     /**
186      * Method addTaglet.
187      * 
188      * @param taglet a taglet object.
189      */
190     public void addTaglet( Taglet taglet )
191     {
192         getTaglets().add( taglet );
193     } //-- void addTaglet( Taglet )
194 
195     /**
196      * Method addTagletArtifact.
197      * 
198      * @param tagletArtifact a tagletArtifact object.
199      */
200     public void addTagletArtifact( TagletArtifact tagletArtifact )
201     {
202         getTagletArtifacts().add( tagletArtifact );
203     } //-- void addTagletArtifact( TagletArtifact )
204 
205     /**
206      * Method getBootclasspathArtifacts.
207      * 
208      * @return List
209      */
210     public java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
211     {
212         if ( this.bootclasspathArtifacts == null )
213         {
214             this.bootclasspathArtifacts = new java.util.ArrayList<BootclasspathArtifact>();
215         }
216 
217         return this.bootclasspathArtifacts;
218     } //-- java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
219 
220     /**
221      * Method getDocletArtifacts.
222      * 
223      * @return List
224      */
225     public java.util.List<DocletArtifact> getDocletArtifacts()
226     {
227         if ( this.docletArtifacts == null )
228         {
229             this.docletArtifacts = new java.util.ArrayList<DocletArtifact>();
230         }
231 
232         return this.docletArtifacts;
233     } //-- java.util.List<DocletArtifact> getDocletArtifacts()
234 
235     /**
236      * Method getExcludePackageNames.
237      * 
238      * @return List
239      */
240     public java.util.List<String> getExcludePackageNames()
241     {
242         if ( this.excludePackageNames == null )
243         {
244             this.excludePackageNames = new java.util.ArrayList<String>();
245         }
246 
247         return this.excludePackageNames;
248     } //-- java.util.List<String> getExcludePackageNames()
249 
250     /**
251      * Get list of exclusion patterns separated by ':' for deep
252      * copying of the '&#42;&#42;/doc-files' directories.
253      * 
254      * @return String
255      */
256     public String getExcludedDocfilesSubdirs()
257     {
258         return this.excludedDocfilesSubdirs;
259     } //-- String getExcludedDocfilesSubdirs()
260 
261     /**
262      * Method getGroups.
263      * 
264      * @return List
265      */
266     public java.util.List<Group> getGroups()
267     {
268         if ( this.groups == null )
269         {
270             this.groups = new java.util.ArrayList<Group>();
271         }
272 
273         return this.groups;
274     } //-- java.util.List<Group> getGroups()
275 
276     /**
277      * Get path relative to project basedir where javadoc resources
278      * were located. 
279      *             This is mainly useful in multimodule builds
280      * where the reactor is still populated.
281      * 
282      * @return String
283      */
284     public String getJavadocResourcesDirectory()
285     {
286         return this.javadocResourcesDirectory;
287     } //-- String getJavadocResourcesDirectory()
288 
289     /**
290      * Method getLinks.
291      * 
292      * @return List
293      */
294     public java.util.List<String> getLinks()
295     {
296         if ( this.links == null )
297         {
298             this.links = new java.util.ArrayList<String>();
299         }
300 
301         return this.links;
302     } //-- java.util.List<String> getLinks()
303 
304     /**
305      * Get the modelEncoding field.
306      * 
307      * @return String
308      */
309     public String getModelEncoding()
310     {
311         return this.modelEncoding;
312     } //-- String getModelEncoding()
313 
314     /**
315      * Method getOfflineLinks.
316      * 
317      * @return List
318      */
319     public java.util.List<OfflineLink> getOfflineLinks()
320     {
321         if ( this.offlineLinks == null )
322         {
323             this.offlineLinks = new java.util.ArrayList<OfflineLink>();
324         }
325 
326         return this.offlineLinks;
327     } //-- java.util.List<OfflineLink> getOfflineLinks()
328 
329     /**
330      * Method getResourcesArtifacts.
331      * 
332      * @return List
333      */
334     public java.util.List<ResourcesArtifact> getResourcesArtifacts()
335     {
336         if ( this.resourcesArtifacts == null )
337         {
338             this.resourcesArtifacts = new java.util.ArrayList<ResourcesArtifact>();
339         }
340 
341         return this.resourcesArtifacts;
342     } //-- java.util.List<ResourcesArtifact> getResourcesArtifacts()
343 
344     /**
345      * Method getTagletArtifacts.
346      * 
347      * @return List
348      */
349     public java.util.List<TagletArtifact> getTagletArtifacts()
350     {
351         if ( this.tagletArtifacts == null )
352         {
353             this.tagletArtifacts = new java.util.ArrayList<TagletArtifact>();
354         }
355 
356         return this.tagletArtifacts;
357     } //-- java.util.List<TagletArtifact> getTagletArtifacts()
358 
359     /**
360      * Method getTaglets.
361      * 
362      * @return List
363      */
364     public java.util.List<Taglet> getTaglets()
365     {
366         if ( this.taglets == null )
367         {
368             this.taglets = new java.util.ArrayList<Taglet>();
369         }
370 
371         return this.taglets;
372     } //-- java.util.List<Taglet> getTaglets()
373 
374     /**
375      * Method getTags.
376      * 
377      * @return List
378      */
379     public java.util.List<Tag> getTags()
380     {
381         if ( this.tags == null )
382         {
383             this.tags = new java.util.ArrayList<Tag>();
384         }
385 
386         return this.tags;
387     } //-- java.util.List<Tag> getTags()
388 
389     /**
390      * Get enables deep copying of the '&#42;&#42;/doc-files'
391      * directories and the specific 'resources' directory.
392      * 
393      * @return boolean
394      */
395     public boolean isDocfilesSubdirsUsed()
396     {
397         return this.docfilesSubdirsUsed;
398     } //-- boolean isDocfilesSubdirsUsed()
399 
400     /**
401      * Method removeBootclasspathArtifact.
402      * 
403      * @param bootclasspathArtifact a bootclasspathArtifact object.
404      */
405     public void removeBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
406     {
407         getBootclasspathArtifacts().remove( bootclasspathArtifact );
408     } //-- void removeBootclasspathArtifact( BootclasspathArtifact )
409 
410     /**
411      * Method removeDocletArtifact.
412      * 
413      * @param docletArtifact a docletArtifact object.
414      */
415     public void removeDocletArtifact( DocletArtifact docletArtifact )
416     {
417         getDocletArtifacts().remove( docletArtifact );
418     } //-- void removeDocletArtifact( DocletArtifact )
419 
420     /**
421      * Method removeExcludePackageName.
422      * 
423      * @param string a string object.
424      */
425     public void removeExcludePackageName( String string )
426     {
427         getExcludePackageNames().remove( string );
428     } //-- void removeExcludePackageName( String )
429 
430     /**
431      * Method removeGroup.
432      * 
433      * @param group a group object.
434      */
435     public void removeGroup( Group group )
436     {
437         getGroups().remove( group );
438     } //-- void removeGroup( Group )
439 
440     /**
441      * Method removeLink.
442      * 
443      * @param string a string object.
444      */
445     public void removeLink( String string )
446     {
447         getLinks().remove( string );
448     } //-- void removeLink( String )
449 
450     /**
451      * Method removeOfflineLink.
452      * 
453      * @param offlineLink a offlineLink object.
454      */
455     public void removeOfflineLink( OfflineLink offlineLink )
456     {
457         getOfflineLinks().remove( offlineLink );
458     } //-- void removeOfflineLink( OfflineLink )
459 
460     /**
461      * Method removeResourcesArtifact.
462      * 
463      * @param resourcesArtifact a resourcesArtifact object.
464      */
465     public void removeResourcesArtifact( ResourcesArtifact resourcesArtifact )
466     {
467         getResourcesArtifacts().remove( resourcesArtifact );
468     } //-- void removeResourcesArtifact( ResourcesArtifact )
469 
470     /**
471      * Method removeTag.
472      * 
473      * @param tag a tag object.
474      */
475     public void removeTag( Tag tag )
476     {
477         getTags().remove( tag );
478     } //-- void removeTag( Tag )
479 
480     /**
481      * Method removeTaglet.
482      * 
483      * @param taglet a taglet object.
484      */
485     public void removeTaglet( Taglet taglet )
486     {
487         getTaglets().remove( taglet );
488     } //-- void removeTaglet( Taglet )
489 
490     /**
491      * Method removeTagletArtifact.
492      * 
493      * @param tagletArtifact a tagletArtifact object.
494      */
495     public void removeTagletArtifact( TagletArtifact tagletArtifact )
496     {
497         getTagletArtifacts().remove( tagletArtifact );
498     } //-- void removeTagletArtifact( TagletArtifact )
499 
500     /**
501      * Set a list of BootclasspathArtifact parameters.
502      * 
503      * @param bootclasspathArtifacts a bootclasspathArtifacts object
504      */
505     public void setBootclasspathArtifacts( java.util.List<BootclasspathArtifact> bootclasspathArtifacts )
506     {
507         this.bootclasspathArtifacts = bootclasspathArtifacts;
508     } //-- void setBootclasspathArtifacts( java.util.List )
509 
510     /**
511      * Set enables deep copying of the '&#42;&#42;/doc-files'
512      * directories and the specific 'resources' directory.
513      * 
514      * @param docfilesSubdirsUsed a docfilesSubdirsUsed object.
515      */
516     public void setDocfilesSubdirsUsed( boolean docfilesSubdirsUsed )
517     {
518         this.docfilesSubdirsUsed = docfilesSubdirsUsed;
519     } //-- void setDocfilesSubdirsUsed( boolean )
520 
521     /**
522      * Set a list of DocletArtifact parameters.
523      * 
524      * @param docletArtifacts a docletArtifacts object.
525      */
526     public void setDocletArtifacts( java.util.List<DocletArtifact> docletArtifacts )
527     {
528         this.docletArtifacts = docletArtifacts;
529     } //-- void setDocletArtifacts( java.util.List )
530 
531     /**
532      * Set list of subpackage patterns to exclude from javadoc
533      * generation.
534      * 
535      * @param excludePackageNames a excludePackageNames object.
536      */
537     public void setExcludePackageNames( java.util.List<String> excludePackageNames )
538     {
539         this.excludePackageNames = excludePackageNames;
540     } //-- void setExcludePackageNames( java.util.List )
541 
542     /**
543      * Set list of exclusion patterns separated by ':' for deep
544      * copying of the '&#42;&#42;/doc-files' directories.
545      * 
546      * @param excludedDocfilesSubdirs a excludedDocfilesSubdirs
547      * object.
548      */
549     public void setExcludedDocfilesSubdirs( String excludedDocfilesSubdirs )
550     {
551         this.excludedDocfilesSubdirs = excludedDocfilesSubdirs;
552     } //-- void setExcludedDocfilesSubdirs( String )
553 
554     /**
555      * Set a list of Group parameters.
556      * 
557      * @param groups a groups object.
558      */
559     public void setGroups( java.util.List<Group> groups )
560     {
561         this.groups = groups;
562     } //-- void setGroups( java.util.List )
563 
564     /**
565      * Set path relative to project basedir where javadoc resources
566      * were located. 
567      *             This is mainly useful in multimodule builds
568      * where the reactor is still populated.
569      * 
570      * @param javadocResourcesDirectory a javadocResourcesDirectory
571      * object.
572      */
573     public void setJavadocResourcesDirectory( String javadocResourcesDirectory )
574     {
575         this.javadocResourcesDirectory = javadocResourcesDirectory;
576     } //-- void setJavadocResourcesDirectory( String )
577 
578     /**
579      * Set list of URLs to javadocs for external classes.
580      * 
581      * @param links a links object.
582      */
583     public void setLinks( java.util.List<String> links )
584     {
585         this.links = links;
586     } //-- void setLinks( java.util.List )
587 
588     /**
589      * Set the modelEncoding field.
590      * 
591      * @param modelEncoding a modelEncoding object.
592      */
593     public void setModelEncoding( String modelEncoding )
594     {
595         this.modelEncoding = modelEncoding;
596     } //-- void setModelEncoding( String )
597 
598     /**
599      * Set a list of OfflineLink parameters.
600      * 
601      * @param offlineLinks a offlineLinks object.
602      */
603     public void setOfflineLinks( java.util.List<OfflineLink> offlineLinks )
604     {
605         this.offlineLinks = offlineLinks;
606     } //-- void setOfflineLinks( java.util.List )
607 
608     /**
609      * Set a list of ResourcesArtifact parameters.
610      * 
611      * @param resourcesArtifacts a resourcesArtifacts object.
612      */
613     public void setResourcesArtifacts( java.util.List<ResourcesArtifact> resourcesArtifacts )
614     {
615         this.resourcesArtifacts = resourcesArtifacts;
616     } //-- void setResourcesArtifacts( java.util.List )
617 
618     /**
619      * Set a list of TagletArtifact parameters.
620      * 
621      * @param tagletArtifacts a tagletArtifacts object.
622      */
623     public void setTagletArtifacts( java.util.List<TagletArtifact> tagletArtifacts )
624     {
625         this.tagletArtifacts = tagletArtifacts;
626     } //-- void setTagletArtifacts( java.util.List )
627 
628     /**
629      * Set a list of Taglet parameters.
630      * 
631      * @param taglets a taglets object.
632      */
633     public void setTaglets( java.util.List<Taglet> taglets )
634     {
635         this.taglets = taglets;
636     } //-- void setTaglets( java.util.List )
637 
638     /**
639      * Set a list of Tag parameters.
640      * 
641      * @param tags a tags object.
642      */
643     public void setTags( java.util.List<Tag> tags )
644     {
645         this.tags = tags;
646     } //-- void setTags( java.util.List )
647 
648 }